Skip to main content
GET
Get a custom_field

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

id
string
required

The custom_field ID

Response

successful

id
string
required

The custom field ID

Example:

"abc123xyz"

field_key
string
required

The unique field key

Example:

"pageport_lead_source"

display_name
string
required

The human-readable field name

Example:

"Lead Source"

entity_type
enum<string>
required

The entity type this field applies to

Available options:
Household,
Person,
Contact,
Opportunity
Example:

"Household"

field_type
enum<string>
required

The field data type

Available options:
text,
number,
date,
boolean,
single_select,
multi_select,
cross_reference
Example:

"text"

options
object | null

Field-specific options (e.g., select_options for select fields, cross_reference_allowed_target_types for cross_reference)