> ## Documentation Index > Fetch the complete documentation index at: https://terminal49-feat-trade-intel-sdk.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List custom field definitions > List every custom field definition configured for your Terminal49 account, including data type, slug, and the target resource each definition applies to. List all custom field definitions available to your account. ## Query filters | Filter | Description | | - | - | | `filter[entity_type]` | Filter by entity type (`Shipment` or `Container`) | | `filter[data_type]` | Filter by data type | | `filter[display_name]` | Filter by display name (prefix match) | ## OpenAPI ````yaml get /custom_field_definitions 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 - name: Parties - name: Trade Intelligence description: >- Trade intelligence answers questions about who imports what into the US, from where, on which carriers, and how that changes over time. The data is US import bill-of-lading records (US Customs vessel manifests): every ocean container landed at a US port (plus US-bound cargo landed at Vancouver, BC) from January 2022 to today, refreshed daily. It does not include air freight, exports, or domestic moves. **Access.** Trade intelligence is enabled per account. Accounts without it receive `403 Forbidden` with `{"error": "Trade intelligence is not enabled for this account"}`; contact sales@terminal49.com to enable it. Requests are limited to roughly 120 per minute per account (`429` with `{"error": "Rate limit exceeded; retry in a minute"}`). **Format.** These endpoints accept and return plain JSON, not JSON:API. Send `Content-Type: application/json` on `POST` requests and authenticate exactly like every other v2 endpoint (`Authorization: Token YOUR_API_KEY`). **Typical flow.** Resolve a name or product first, then analyze: `companies/search` or `commodities/search` give you the exact `company_name` or `hs4` to pass to `companies/profile`, `importers/top`, `trends`, or `breakdown`. Container and bill of lading numbers go straight to `containers/lookup` and `bills_of_lading/lookup`. **Reading the numbers.** - **Volume is physical containers.** Each box is counted once, even when it appears on several bills of lading. A container carrying several HS codes counts once per code and companies can share containers, so do not add volumes across HS codes or companies; take market totals from `trends` or `breakdown` without a company filter. - **Estimated value is a modelled USD estimate**, not the declared customs value. - **The current month is partial.** `trends` and `breakdown` include it by default; `companies/profile` and `importers/top` use full calendar months. Compare full months against the same months a year earlier. - **Absent volume is not small volume.** Importers can ask US Customs to withhold their name from manifests, and much large-retail freight is booked under forwarders or suppliers. Treat a company's figures as a floor, never as its size. - **One company, many names.** Company names are normalized but split by state, and large importers use several names (distribution, merchandising, and DC entities). Related entities are separate companies; report them separately. `companies/search` ranks by match quality, not by size. - **Companies are the consignee or notify party on the bill.** Forwarders, NVOCCs, and customs brokers appear alongside cargo owners. A high notify-party share, or LOGISTICS, FREIGHT, SHIPPING, CUSTOMS, or BROKERAGE in the name, usually indicates a logistics provider. - **Carriers, countries, and ports use the manifests' spellings**, and carriers appear under spelling variants (for example `CMA CGM` and `CMA CGM AMERICA LLC`). Filter with substrings and merge variants before computing shares. - **HS4 descriptions are truncated.** Check `common_goods` from `commodities/search` before relying on a code. paths: /custom_field_definitions: get: tags: - Custom Field Definitions summary: List custom field definitions operationId: get-custom-field-definitions 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[data_type] description: Filter by data type - schema: type: string in: query name: filter[display_name] description: Filter by display name (prefix match) responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/custom_field_definition' links: $ref: '#/components/schemas/links' meta: $ref: '#/components/schemas/meta' components: schemas: custom_field_definition: title: Custom field definition type: object properties: id: type: string format: uuid type: type: string enum: - custom_field_definition attributes: type: object properties: entity_type: type: string enum: - Shipment - Container - TrackingRequest api_slug: type: string display_name: type: string description: type: string nullable: true data_type: type: string enum: - short_text - number - date - datetime - boolean - enum - enum_multi - reference reference_type: type: string nullable: true validation: type: object nullable: true additionalProperties: true default_format: type: string nullable: true default_value: $ref: '#/components/schemas/custom_field_value' required: - entity_type - api_slug - display_name - data_type 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` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.