Skip to main content
Custom Fields

Get a custom field by ID

Retrieves a single custom field by its unique identifier.

GET
/v2/custom_fields/{id}

Returns the custom field object if found in your organization.

Response

Returns a custom field object with:

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

Errors

  • 404 - Custom field not found in your organization

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

idstringrequired

Custom field unique identifier

Example: 65d26304b2e65b1e1278170c

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

allowMultipleboolean

Whether multiple files can be uploaded (file fields only)

Example: false
createdAtstring

ISO timestamp when created

Example: 2025-04-06T14:11:58.141Z
idstringrequired

Unique identifier

Example: 65d26304b2e65b1e1278170c
internalboolean

Whether the field is for internal use only

Example: false
labelstringrequired

Field label displayed to users

Example: Your @username
objectenum<string>required

Object type identifier

Available options: custom_field
Example: custom_field
optionsobject[]

Options for select/multi-select fields

placeholderstring

Placeholder text

Example: Enter your username
publicboolean

Whether the field value is publicly visible

Example: false
requiredboolean

Whether the field is required

Example: true
typeenum<string>required

Field type

Available options: text, number, select, multi-select, checkbox, date, file
Example: text
updatedAtstring

ISO timestamp when last updated

Example: 2025-04-06T14:11:58.141Z

Still need help? Ask the team