For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
GuidesAPI Reference
GuidesAPI Reference
  • Endpoints
      • POSTCreate a carrier
      • POSTBatch create carriers
      • GETList carriers
      • GETGet a carrier
      • PATCHUpdate a carrier
      • POSTRe-enable a previously disabled carrier
      • POSTDisable a carrier organization-wide
LogoLogo
SupportDashboard
EndpointsCarriers

List carriers

GET
/carriers
GET
/api/v1/carriers
$curl https://tryenvoy.ai/api/v1/carriers \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": "car_9f8b7c6d-1234-4a56-b789-0f1e2d3c4b5a",
5      "name": "Swift Logistics",
6      "mc_number": "MC123456",
7      "dot_number": "DOT987654",
8      "email": "[email protected]",
9      "phone": "+1-555-123-4567",
10      "dispatcher_name": "Jane Doe",
11      "dispatcher_phone": "+1-555-765-4321",
12      "dispatcher_email": "[email protected]",
13      "is_active": true,
14      "provider": "Envoy AI",
15      "ingestion_method": "API",
16      "equipment_types": [
17        "VAN",
18        "REEFER"
19      ],
20      "insurance_expiration": "2024-12-31T23:59:59Z",
21      "w9_on_file": true,
22      "authorized_for_hire": true,
23      "on_time_pickup_pct": 95.4,
24      "on_time_delivery_pct": 92.7,
25      "tracking_compliance_pct": 88.3,
26      "avg_response_time_min": 15.2,
27      "total_loads_hauled": 1245,
28      "is_onboarded": true,
29      "carrier_rep_user_id": "usr_4a3b2c1d-5678-4e90-b123-456789abcdef",
30      "carrier_rep_name": "Michael Smith",
31      "carrier_rep_email": "[email protected]",
32      "is_verified": true,
33      "verified_date": "2023-11-20T10:15:00Z",
34      "created_at": "2022-05-10T08:00:00Z",
35      "updated_at": "2024-04-01T12:00:00Z"
36    }
37  ],
38  "pagination": {
39    "page": 1,
40    "page_size": 20,
41    "total_count": 150,
42    "total_pages": 8,
43    "has_next": true,
44    "has_prev": false
45  }
46}

List carriers with pagination and optional search by name, MC#, or DOT#.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get a carrier

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional

Query parameters

searchstring or nullOptional

Search by name, MC#, DOT#

is_activeboolean or nullOptionalDefaults to true
Filter by active status
pageintegerOptional>=1Defaults to 1
Page number
page_sizeintegerOptional1-100Defaults to 20
Results per page

Response

Successful Response
datalist of objects
List of items for the current page
paginationobject
Pagination metadata

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error