Get a custom field
Custom Fields
Get a custom field
Retrieve a single custom field value record from the Terminal49 API, including the resolved value, related definition slug, and parent resource reference.
GET
Get a custom field
Use this endpoint to retrieve a single custom field value by its ID.Documentation Index
Fetch the complete documentation index at: https://terminal49.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Path parameters
| Parameter | Description |
|---|---|
id | The 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 type | Storage | Display format |
|---|---|---|
short_text | String | As-is |
number | Decimal (precision: 18, scale: 6) | Formatted per default_format |
date | Date | YYYY-MM-DD or custom format |
datetime | DateTime | YYYY-MM-DD HH:MM:SS or custom format |
boolean | Boolean | Yes or No |
enum | String | Option label |
enum_multi | Comma-separated string | Comma-separated labels |
Authorizations
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
Custom field ID