> ## 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.

# List custom fields

> List custom field value records across your account in the Terminal49 API, with filters for definition slug, target resource type, and resource ID.

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:

| Filter                  | Description                                       |
| ----------------------- | ------------------------------------------------- |
| `filter[entity_type]`   | Filter by entity type (`Shipment` or `Container`) |
| `filter[entity_id]`     | Filter by the ID of the shipment or container     |
| `filter[definition_id]` | Filter by custom field definition ID              |

## 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


## OpenAPI

````yaml get /custom_fields
openapi: 3.0.0
info:
  title: Terminal49 API Reference
  version: 0.2.0
  contact:
    name: Terminal49 API support
    url: https://www.terminal49.com
    email: support@terminal49.com
  description: >-
    The Terminal 49 API offers a convenient way to programmatically track your
    shipments from origin to destination.


    Please enter your API key into the "Variables" tab before using these
    endpoints within Postman.
  x-label: Beta
  termsOfService: https://www.terminal49.com/terms
servers:
  - url: https://api.terminal49.com/v2
    description: Production
security:
  - authorization: []
tags:
  - name: Containers
  - name: Custom Field Definitions
  - name: Custom Field Options
  - name: Custom Fields
  - name: Shipments
  - name: Locations
  - name: Events
  - name: Tracking Requests
  - name: Webhooks
  - name: Webhook Notifications
  - name: Ports
  - name: Metro Areas
  - name: Terminals
  - name: Routing (Paid)
  - name: Documents
  - name: Email Submissions
  - name: Document Schemas
  - name: Search
paths:
  /custom_fields:
    get:
      tags:
        - Custom Fields
      summary: List custom fields
      operationId: get-custom-fields
      parameters:
        - schema:
            type: integer
            default: 1
          in: query
          name: page[number]
        - schema:
            type: integer
            default: 25
          in: query
          name: page[size]
        - schema:
            type: string
          in: query
          name: filter[entity_type]
          description: Filter by entity type (Shipment or Container)
        - schema:
            type: string
          in: query
          name: filter[entity_id]
          description: Filter by entity ID
        - schema:
            type: string
          in: query
          name: filter[definition_id]
          description: Filter by custom field definition ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/custom_field'
                  links:
                    $ref: '#/components/schemas/links'
                  meta:
                    $ref: '#/components/schemas/meta'
components:
  schemas:
    custom_field:
      title: Custom field
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - custom_field
        attributes:
          type: object
          properties:
            api_slug:
              type: string
            value:
              $ref: '#/components/schemas/custom_field_value'
            display_value:
              type: string
              nullable: true
              description: Formatted value for display
          required:
            - api_slug
        relationships:
          type: object
          properties:
            entity:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - shipment
                        - container
                        - tracking_request
                    id:
                      type: string
                      format: uuid
                  required:
                    - type
                    - id
            definition:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - custom_field_definition
                    id:
                      type: string
                      format: uuid
                  required:
                    - type
                    - id
      required:
        - id
        - type
    links:
      title: links
      type: object
      properties:
        last:
          type: string
          format: uri
        next:
          type: string
          format: uri
        prev:
          type: string
          format: uri
        first:
          type: string
          format: uri
        self:
          type: string
          format: uri
    meta:
      title: meta
      type: object
      properties:
        size:
          type: integer
        total:
          type: integer
    custom_field_value:
      description: Raw custom field value (type depends on definition)
      nullable: true
      oneOf:
        - type: string
        - type: number
        - type: boolean
        - type: array
          items:
            type: string
        - type: object
  securitySchemes:
    authorization:
      name: Authorization
      type: apiKey
      in: header
      description: >-
        Use a Terminal49 API key in the `Authorization` header with the `Token`
        prefix.


        `Authorization: Token YOUR_API_KEY`

````