Sign in
Custom Fields

Get custom field

Retrieve a specific custom field definition by id.

get/public/v1/custom-fields/{custom_field_id}/

Path parameters

custom_field_idinteger required

Response

OK

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

idinteger required
company_idinteger nullable
company_idsinteger[]
namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
optionsstring[] nullable
is_activeboolean required

Changes

Changed in 1 of the 27 revisions of this API.2

  • d0cd912ee42d2See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 27 revisions, 1 has no diff computed.