API Reference

Get carriers in a broker's network

get
https://example.com/mynetwork

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to Favorite

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

Allowed:
string
enum
Defaults to MyCarriers

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

Allowed:
string

The DOT number to filter carriers by. Exact match.

carrier_operation
array of objects

The carrier operation to filter carriers by.

carrier_operation
string
enum

The entity type to filter carriers by.

Allowed:
string

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

boolean

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.

integer
≥ 1
Defaults to 1

The page of data to retrieve.

integer
1 to 5000
Defaults to 1000

The number of items per page.

string

The field to sort by

string
enum
Defaults to Asc

The sort order

Allowed:
Responses

Updated about 2 hours ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago