Skip to main content
GET
List custom field definitions
List all custom field definitions available to your account.

Query filters

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Query Parameters

page[number]
integer
default:1
page[size]
integer
default:25
filter[entity_type]
string

Filter by entity type (Shipment or Container)

filter[data_type]
string

Filter by data type

filter[display_name]
string

Filter by display name (prefix match)

Response

200 - application/json

OK

data
Custom field definition ยท object[]
meta
meta ยท object