Skip to main content
GET
/
custom_fields
/
{id}
Get a custom field
curl --request GET \
  --url https://api.terminal49.com/v2/custom_fields/{id} \
  --header 'Authorization: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "custom_field",
    "attributes": {
      "api_slug": "<string>",
      "value": "<string>",
      "display_value": "<string>"
    },
    "relationships": {
      "entity": {
        "data": {
          "type": "shipment",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "definition": {
        "data": {
          "type": "custom_field_definition",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  },
  "links": {
    "self": "<string>"
  }
}
Use this endpoint to retrieve a single custom field value by its ID.

Path parameters

ParameterDescription
idThe unique identifier of the custom field value

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:
Data typeStorageDisplay format
short_textStringAs-is
numberDecimal (precision: 18, scale: 6)Formatted per default_format
dateDateYYYY-MM-DD or custom format
datetimeDateTimeYYYY-MM-DD HH:MM:SS or custom format
booleanBooleanYes or No
enumStringOption label
enum_multiComma-separated stringComma-separated labels

Authorizations

Authorization
string
header
required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

id
string
required

Custom field ID

Response

200 - application/json

OK

data
Custom field · object