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
      • POSTInitiate carrier outreach
      • GETList outreaches
      • GETGet an outreach record
LogoLogo
SupportDashboard
EndpointsOutreaches

List outreaches

GET
/outreaches
GET
/api/v1/outreaches
$curl https://tryenvoy.ai/api/v1/outreaches \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": "otr_3f9a1b2c-4d5e-6789-abcd-1234567890ef",
5      "carrier": {
6        "id": "car_7a8b9c0d-1e2f-3456-789a-bcdef0123456",
7        "name": "Swift Logistics",
8        "mc_number": "MC123456",
9        "dot_number": "DOT987654",
10        "email": "[email protected]",
11        "phone": "+1-555-123-4567",
12        "dispatcher_name": "Jane Doe",
13        "dispatcher_phone": "+1-555-765-4321",
14        "dispatcher_email": "[email protected]",
15        "is_active": true,
16        "provider": "EnvoyAI",
17        "ingestion_method": "API",
18        "equipment_types": [
19          "VAN",
20          "REEFER"
21        ],
22        "insurance_expiration": "2024-12-31T23:59:59Z",
23        "w9_on_file": true,
24        "authorized_for_hire": true,
25        "on_time_pickup_pct": 95.5,
26        "on_time_delivery_pct": 97.2,
27        "tracking_compliance_pct": 92.8,
28        "avg_response_time_min": 15.3,
29        "total_loads_hauled": 1240,
30        "is_onboarded": true,
31        "carrier_rep_user_id": "usr_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
32        "carrier_rep_name": "John Smith",
33        "carrier_rep_email": "[email protected]",
34        "is_verified": true,
35        "verified_date": "2023-11-01T10:00:00Z",
36        "created_at": "2022-05-15T08:30:00Z",
37        "updated_at": "2024-04-10T14:45:00Z"
38      },
39      "load_id": "load_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
40      "modality": "call",
41      "direction": "outbound",
42      "created_at": "2024-04-20T09:15:00Z",
43      "load_number": "LD123456789",
44      "carrier_engaged": true,
45      "call_id": "call_abcdef12-3456-7890-abcd-ef1234567890",
46      "conversation_id": "conv_12345678-90ab-cdef-1234-567890abcdef"
47    }
48  ],
49  "pagination": {
50    "page": 1,
51    "page_size": 1,
52    "total_count": 25,
53    "total_pages": 25,
54    "has_next": true,
55    "has_prev": false
56  }
57}

Get outreach records for the organization. Filter by load ID.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get an outreach record

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

load_idstring or nullOptionalformat: "uuid"
Filter outreaches by load ID

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