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.
Authorizations
Query Parameters
Return only records matching organization ID. Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Return only records matching custom field name or slug.
Return only records matching custom field type.
text, number, date, checkbox, select Results page to return. The first page is used by default.
Records returned per page. Defaults to 10 and accepts up to 100.
Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.
created_at, -created_at, slug, -slug, name, -name, type, -type Response
Request completed successfully
Schema for a custom field of type text.
- CustomFieldText
- CustomFieldNumber
- CustomFieldDate
- CustomFieldCheckbox
- CustomFieldSelect