Sign in

v1

latestOpenAPI 3.1.02026-07-246246106.8 KB
Carrier Hub

Get carriers in a broker's network

Returns the list of carriers in the authenticated broker's network, with support for filtering, searching, sorting, and paging. Callers entitled to advanced risk data will additionally receive the carrier's current compliance status; all other callers will receive a null compliance status for every row.

get/mynetwork

Query parameters

relationship_type'Favorite' | 'Blocked' | 'Watched'

The type of relationship

The type of relationship to return. Must be a relationship type that is tracked at the account level (e.g. Watched). Defaults to Watched.

relationship_type_group'MyCarriers' | 'CarrierHubNetwork'

The group of relationship types

The group of relationship types to return. Must be a group that is tracked at the account level (e.g. CarrierHubNetwork). Defaults to CarrierHubNetwork.

dot_numberstring

The DOT number to filter carriers by. Exact match.

carrier_operationCarrierOperationType[]

The carrier operation to filter carriers by.

entity_type'Carrier' | 'ShipperOnly' | 'Broker' | 'Registrant' | 'FreightForwarder' | 'IntermodalEquipmentProvider' | 'CargoTank'

Types of entities associated with the carrier

The entity type to filter carriers by.

searchstring

Value to search carriers by. Partial match on DOT number, MC number, or company name.

is_activeboolean

Filter by active state. When true, returns only carriers on the broker's active list. When false, returns only carriers on the inactive list. When omitted, returns both.

pageinteger

The page of data to retrieve.

per_pageinteger

The number of items per page.

sort_bystring

The field to sort by

sort_order'Asc' | 'Desc'

The sort order

The sort order

Response

A paginated list of carriers in the broker's network

dotNumberstring

The DOT number for the carrier

mcNumberstring

The MC number for the carrier

companyNamestring

The legal name of the carrier

doingBusinessAsstring nullable

The name the carrier does business as

citystring

The city where the carrier is located

statestring

The state where the carrier is located

postalCodestring

The postal code where the carrier is located

countrystring

ISO2 country code where the carrier is located

carrierOperation'Interstate' | 'IntrastateHmz' | 'IntrastateNonHmz' nullable

The operation type of the carrier

entityTypeEntityType[]

The entity types associated with the carrier

isActiveboolean

Whether the carrier is actively being watched in the broker's network

addedDatestring date-time

The date the carrier was added to the broker's network

updatedDatestring date-time nullable

The date the entry was last updated

complianceStatus'Pass' | 'Fail' | 'Error' | 'Warning' | 'Pending'

The outcome of a rule or policy evaluation

Example response

[
  {
    "dotNumber": "1234567",
    "mcNumber": "MC987654",
    "companyName": "Wayne Enterprises",
    "doingBusinessAs": "Batman Logistics",
    "city": "Gotham",
    "state": "NY",
    "postalCode": "10001",
    "country": "US",
    "entityType": [
      "Carrier"
    ],
    "isActive": true
  }
]