Skip to main content
Tickets

List custom fields

Returns all custom fields configured in your organization that can be used on tickets.

GET
/v2/tickets/custom_fields

This endpoint returns all custom fields at once. No pagination is supported.

Custom Field Object

Each custom field includes:

  • id - Unique field identifier
  • label - Field label displayed to users
  • type - Field type (text, number, select, multi-select, checkbox, date, file)
  • required - Whether the field is required
  • placeholder - Placeholder text (for text/number fields)
  • public - Whether the field value is publicly visible
  • internal - Whether the field is for internal use only
  • options - Array of options (for select/multi-select fields)
  • allowMultiple - Whether multiple files can be uploaded (file fields only)
Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of custom fields

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

objectenum<string>required

Object type identifier

Available options: list
Example: list
paginationobject

Pagination metadata for page-based requests