Get all carriers

get

https://example.com/carriers

Search carriers with sorting and pagination. scope selects the search space: network (default, the caller's network) or global (all carriers). Each result carries the caller's own relationship (null when out-of-network) and compliance status. All parameters are optional.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

scope

string

enum

Defaults to Network

Search space: 'network' (default) searches only the caller's network; 'global' searches all carriers.

Allowed:

search-criteria

string

length ≥ 1

The criteria to search for carriers. This filters on dot number, docket numbers, DBA Name and Legal Name

dot_number

string

The DOT number to filter carriers by. This is an exact match.

carrier_operation

array of objects

The carrier operation to filter carriers by.

carrier_operation

Allowed:

entity_type

string

enum

The entity type to filter relationships by.

Allowed:

relationship_type

string

enum

Defaults to Watched

The type of relationship to filter by. In a global search, supplying it narrows results to in-network carriers with a matching relationship.

Allowed:

relationship_type_group

string

enum

Defaults to MyCarriers

The group of relationship types to filter by. In a global search, supplying it narrows results to in-network carriers with a matching relationship.

Allowed:

relationship_active

boolean

Filter by relationship active status. In the network scope it defaults to active-only when omitted; in a global search it is applied only when set, narrowing to matching in-network carriers.

page

integer

≥ 1

Defaults to 1

The page of data to retrieve.

per_page

integer

1 to 250

Defaults to 10

The number of items per page.

sort_by

string

The field to sort by (a response JSON property name). Optional; when omitted, search results fall back to their own relevance ordering.

sort_order

string

enum

Defaults to Asc

The sort order. Optional; only applies together with sort_by.

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated response of CarrierSummary

400There was a problem with the data provided for this request.

401Authorization was denied for this request.

500A server side error occurred.