Get custom field

Retrieves a single custom field by its ID.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesCustom field unique identifier

Response Fields

FieldTypeDescription
idintegerCustom field unique identifier
namestringInternal field name (used as key in customFields)
labelstringDisplay label shown in the UI
typestringField type (Text, Select, Number, etc.)
scopestringEntity this field applies to
requiredbooleanWhether the field is mandatory
formulastringFormula expression (for Formula type)
optionsobjectOptions configuration (for Select/MultiSelect)
weightintegerSort order/priority
sizestringCSS width class
editablebooleanWhether the field can be edited
publicbooleanWhether the field is visible publicly
activatebooleanWhether the field is active
enableAibooleanWhether AI features are enabled
hubspotMapstringHubSpot property mapping
isMappedToHubspotbooleanWhether synced with HubSpot
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Returns the custom field details
  • 401 Unauthorized: Invalid or missing API key
  • 404 Not Found: Custom field not found
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Responses
200

Successful response

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!