List custom field definitions

List every custom field definition configured for your Terminal49 account, including data type, slug, and the target resource each definition applies to.

GET /custom_field_definitions

List custom field definitions

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/custom_field_definitions \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "api_slug": "<string>",
        "display_name": "<string>",
        "description": "<string>",
        "reference_type": "<string>",
        "validation": {},
        "default_format": "<string>",
        "default_value": "<string>"
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

List all custom field definitions available to your account.

Query filters

Filter	Description
filter[entity_type]	Filter by entity type (Shipment or Container)
filter[data_type]	Filter by data type
filter[display_name]	Filter by display name (prefix match)

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[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes