Get Custom Field Definition

GET

/api/:account_id/custom-field-definitions/:external_id

Get a custom field definition by ID.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

external_idstringRequired

The custom field definition ID (e.g., ‘cfd_dev_abc123’)

account_idstringRequired

Successful Response

idstring

Unique identifier for the definition (e.g., ‘cfd_dev_abc123’)

field_keystring

The key used when setting values on entities

entity_typeenum

The entity type this field applies to

data_typeenum

The data type for values

display_namestring

Human-readable name for the field

is_visible_in_listboolean

Whether this field appears as a column in list views

created_atdatetime

When the definition was created

updated_atdatetime

When the definition was last updated

descriptionstring or nullOptional

Optional description of the field

constraintsmap from strings to any or nullOptional

Type-specific constraints

422

Unprocessable Entity Error

1	{
2	"id": "cfd_dev_abc123",
3	"field_key": "customer_loyalty_level",
4	"entity_type": "customer",
5	"data_type": "text",
6	"display_name": "Loyalty Level",
7	"is_visible_in_list": true,
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-04-10T14:45:00Z",
10	"description": "Indicates the loyalty tier assigned to the customer",
11	"constraints": {
12	"maxLength": 50,
13	"allowedValues": [
14	"Bronze",
15	"Silver",
16	"Gold",
17	"Platinum"
18	]
19	}
20	}

$	curl https://app.paymentkit.com/api/account_id/custom-field-definitions/external_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"