List Favorite Carriers

List favorite carriers with full details from Vortex.

Fetches favorite IDs from Nexus, then queries Vortex for carrier data. Supports search and pagination within the favorites set.

get/v2/tms/carriers/favorites

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

TMS integration connection ID

searchstring nullable

Search within favorites by name or DOT#

limitinteger

offsetinteger

sort_bystring

Sort field

sort_orderstring

Sort order

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.