Skip to main content
GET
Get a custom field
Use this endpoint to retrieve a single custom field value by its ID.

Path parameters

Response

The response includes:
  • value - The raw stored value (type depends on the field’s data type)
  • display_value - Human-readable formatted value
  • Relationships to the associated entity (shipment or container), definition, and the user who last updated it

Data types

Custom fields support these data types, each with specific value handling:

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

id
string
required

Custom field ID

Response

200 - application/json

OK

data
Custom field · object