MEmentium
v2
tms
v2
tms
carriers

Search Carriers

Search for carriers with various filters

Uses CarrierServiceClient from libs to call Vortex - clean and simple! Note: Contacts and equipment are NOT included by default for performance. Pass include_contacts=true to include contacts (needed for email availability checks). Use GET /carriers/{id} to fetch full carrier details.

Query Parameters: - integration_connection_id: TMS integration connection ID (required) - external_reference_id: Search by external reference ID (for autocomplete/partial matching) - name: Filter by carrier name (partial match) - dot_number: Filter by DOT number (partial match) - phone_number: Filter by phone number (partial match) - include_contacts: Include carrier contacts in response (default: false) - limit: Maximum number of results (default: 20) - offset: Offset for pagination (default: 0)

Returns: List of Carrier models (basic info only unless include_contacts is true)

get/v2/tms/carriers/search

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
namestring nullable
dot_numberstring nullable
phone_numberstring nullable
include_contactsboolean
limitinteger
offsetinteger

Headers

mentium-workspace-idstring nullable

Response

Successful Response

idstring required

Carrier UUID

organization_idstring required

Organization UUID

integration_connection_idstring required

Integration connection UUID

external_reference_idstring required

External reference ID from TMS

namestring required

Carrier name

emailstring nullable

Primary contact email

phone_numberstring nullable

Primary phone number

dot_numberstring nullable

DOT (Department of Transportation) number

mc_numberstring nullable

MC (Motor Carrier) number

billing_currencystring

Billing currency (USD, CAD, MXN)

custom_max_deadhead_distance_miles_analyticsinteger nullable

Carrier-specific maximum deadhead distance (miles) for Analytics Carrier and Load Searches

custom_max_deadhead_distance_miles_potential_empty_truck_nearbyinteger nullable

Carrier-specific maximum deadhead distance (miles) for Potential Empty Truck Nearby Carrier and Load Searches

send_email_offers_enabledboolean

When false, email load offers are not sent to this carrier

email_offers_opted_out_atstring date-time nullable

When the carrier last opted out of email load offers

email_offers_opt_out_reasonstring nullable

Reason provided when opting out of email load offers

email_offers_opted_out_bystring nullable

Who opted the carrier out: broker or carrier

historical_rate_can_exceed_rangeboolean nullable

Honor a historical lane rate even when it falls outside the offer's min/max range (default true)

created_atstring date-time required

Record created timestamp

updated_atstring date-time required

Record updated timestamp

Example response

[
  {
    "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.