List Carriers

List carriers with flexible filtering, pagination and sorting

Note: Equipment and certifications are NOT included in list results for performance. Use GET /carriers/{id} to fetch full carrier details with contacts/equipment/certifications.

Query Parameters: - integration_connection_id: TMS integration connection ID (required) - search: Search across name and DOT number (partial match, OR logic) - external_reference_id: Filter by external reference ID (partial match, for autocomplete) - name: Filter by carrier name (partial match) - dot_number: Filter by DOT number (partial match) - phone_number: Filter by phone number (partial match) - email: Filter by email (partial match) - filters_json: JSON array of dynamic filters for advanced filtering - limit: Maximum results (default: 50, max: 1000) - offset: Pagination offset (default: 0) - sort_by: Sort field (default: "name") - sort_order: Sort order "asc" or "desc" (default: "asc")

Returns: ListCarriersResponse with carriers list, total_count, and has_more flag

get/v2/tms/carriers

Request

Base URL
https://api.mentium.io (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer

Query parameters

integration_connection_idstring required

external_reference_idstring nullable

Filter by external reference ID (partial match, for autocomplete)

searchstring nullable

Search across carrier name and DOT number (partial match, OR logic)

namestring nullable

dot_numberstring nullable

phone_numberstring nullable

emailstring nullable

filters_jsonstring nullable

JSON array of dynamic filters. Single value: [{"field": "name", "operator": "CONTAINS", "value": "Swift"}]. Array values (IN/NOT_IN): [{"field": "name", "operator": "IN", "values": ["Swift", "JB Hunt"]}]. Supported fields: external_reference_id, name, dot_number, phone_number, email. Supported operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, IN, NOT_IN.

limitinteger

Maximum results (default: 50, max: 1000)

offsetinteger

Pagination offset (default: 0)

sort_bystring

Sort field (default: 'name')

sort_orderstring

Sort order 'asc' or 'desc' (default: 'asc')

Headers

mentium-workspace-idstring nullable

Response

Successful Response

total_countinteger required

Total count of carriers matching filters

has_moreboolean required

Whether more carriers exist beyond current page

Example response

{
  "carriers": [
    {
      "addresses": [
        {
          "address_type": "PHYSICAL",
          "city": "Phoenix",
          "country": "USA",
          "data_origin": "TMS",
          "postal_code": "85001",
          "state": "AZ",
          "street": "123 Main St"
        },
        {
          "address_type": "BILLING",
          "city": "Phoenix",
          "country": "USA",
          "data_origin": "TMS",
          "postal_code": "85002",
          "state": "AZ",
          "street": "456 Finance Ave"
        }
      ],
      "certifications": [
        {
          "certification_number": "1bb4726b4337e35d147ec6242b7b25ca",
          "certification_type": "SMART_WAY",
          "data_origin": "HIGHWAY",
          "effective_at": "2024-01-01T00:00:00Z",
          "expiration_at": "2024-12-31T00:00:00Z",
          "is_verified": true,
          "verification_source": "Highway"
        },
        {
          "certification_type": "TANKER_ENDORSED_DRIVERS",
          "data_origin": "HIGHWAY",
          "filed_at": "2024-04-25T00:00:00Z",
          "is_verified": false
        }
      ],
      "contacts": [
        {
          "contact_type": "DISPATCHER",
          "full_name": "John Dispatcher",
          "id": "contact-uuid-123",
          "is_primary_contact": true,
          "primary_email": "john@swift.com",
          "primary_phone": "555-234-5678"
        }
      ],
      "dot_number": "987654",
      "equipment": [
        {
          "equipment_type": "Capabilities",
          "id": "equipment-uuid-789",
          "is_hazmat_certified": true,
          "is_reefer": true,
          "is_team_equipped": true
        }
      ],
      "external_reference_id": "CAR12345",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "integration_connection_id": "int-456",
      "name": "Swift Transportation",
      "organization_id": "org-123",
      "phone_number": "555-123-4567"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.