List custom fields

List custom field value records across your account in the Terminal49 API, with filters for definition slug, target resource type, and resource ID.

GET /custom_fields

List custom fields

cURL

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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "api_slug": "<string>",
        "value": "<string>",
        "display_value": "<string>"
      },
      "relationships": {
        "entity": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "definition": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

Use this endpoint to retrieve custom field values attached to your shipments and containers. Custom fields let you store additional metadata on entities to support your business workflows.

Query filters

Filter results using these query parameters:

Filter	Description
filter[entity_type]	Filter by entity type (Shipment or Container)
filter[entity_id]	Filter by the ID of the shipment or container
filter[definition_id]	Filter by custom field definition ID

Response

The response includes:

• value - The raw stored value
• display_value - Formatted value for display (e.g., formatted numbers, date strings, enum labels)
• Relationships to the entity, definition, and user who last updated the field

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[entity_id] · string

Filter by entity ID

filter[definition_id] · string

Filter by custom field definition ID

Response

200 - application/json

OK

data · Custom field · object[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes