Skip to main content
GET
List custom field definitions
Lists the custom field definitions configured for your account. The list is not paginated. The API ignores page[number] and page[size] and returns every row, but still sends pagination links. Do not follow links.next. The API always returns the definitions of the authenticated user’s account, whatever account_id you pass.

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

Path Parameters

account_id
string<uuid>
required

Your account ID. The API always uses the account of the authenticated user.

Query Parameters

filter[entity_type]
enum<string>

Filter by entity type. Cargo means containers.

Available options:
Shipment,
Cargo
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[]

Pagination links. Each value is an absolute URL. self repeats the request URL as sent, including its query string and its encoding. current, first, prev, next, and last repeat the request's query parameters, with page[number] and page[size] in unencoded brackets.