List Custom Fields
Intent
Reads the available custom fields as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect custom fields. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries custom_fields:read or custom_fields:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
List custom fields.
Scopes: custom_fields:read custom_fields:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Query Parameters
Filter by organization ID. The organization ID.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Filter by custom field name or slug.
Filter by custom field type.
text, number, date, checkbox, select Page number, defaults to 1.
Size of a page, defaults to 10. Maximum is 100.
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
created_at, -created_at, slug, -slug, name, -name, type, -type Response
Successful Response
Schema for a custom field of type text.
- CustomFieldText
- CustomFieldNumber
- CustomFieldDate
- CustomFieldCheckbox
- CustomFieldSelect