Skip to main content
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