Skip to main content
Custom Fields

List custom fields

Returns all custom fields configured in your organization.

GET
/v2/custom_fields

This endpoint returns all custom fields at once (typically a small list). No pagination is supported.

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of custom field objects
  • nextCursor - Always null

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)
  • 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)

Field Types

  • text - Single line text input
  • number - Numeric input
  • select - Single-choice dropdown
  • multi-select - Multiple-choice dropdown
  • checkbox - Boolean checkbox
  • date - Date picker

Authorizations

Authorizationstringheaderrequired

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

Headers

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

Still need help? Ask the team