Skip to main content
GET
List custom fields
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:

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

filter[entity_type]
enum<string>

Filter by entity type. The value must match exactly: Shipment, Cargo (containers) or TrackingRequest.

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

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.