v1
latestOpenAPI 3.0.12026-07-2466310316.3 KBCustom Fields
List Custom Fields
get/api/v1/custom_fields
Query parameters
includestring[]
Custom Field relationships available for inclusion
fields[custom_fields]CustomFieldsReadableAttribute[]
Custom Field readable attributes list
fields[custom_field_options]CustomFieldOptionsReadableAttribute[]
Custom Field Option readable attributes list
filter[template_custom_field_id]integer[]
Template custom field id filter
Filter records by Template custom field id
filter[resource_type]string[]
Resource type filter
Filter records with resource_type equal to this value
sortstring[]
Custom Field sortable attributes
Sort records according to one or more criteria
You should not include both ascending id and descending -id fields the same time
page[number]integer
Example:1
The page number of records to return
page[size]integer
The number of records to return
stats[total]'count'
Example:count
Include the total number of matched records within the meta key of the response object.
Response
OK: Custom Fields collection