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

Get an outreach record

GET
/outreaches/:outreach_id
GET
/api/v1/outreaches/:outreach_id
$curl https://tryenvoy.ai/api/v1/outreaches/outreach_id \
>     -H "Authorization: Bearer <token>"
1{
2  "id": "otr_00000000-0000-0000-0000-000000000000",
3  "carrier": {
4    "id": "car_00000000-0000-0000-0000-000000000000",
5    "name": "string",
6    "mc_number": "string",
7    "dot_number": "string",
8    "email": "string",
9    "phone": "string",
10    "dispatcher_name": "string",
11    "dispatcher_phone": "string",
12    "dispatcher_email": "string",
13    "is_active": true,
14    "provider": "string",
15    "ingestion_method": "string",
16    "equipment_types": [
17      "VAN"
18    ],
19    "insurance_expiration": "2024-01-15T09:30:00Z",
20    "w9_on_file": true,
21    "authorized_for_hire": true,
22    "on_time_pickup_pct": 1.1,
23    "on_time_delivery_pct": 1.1,
24    "tracking_compliance_pct": 1.1,
25    "avg_response_time_min": 1.1,
26    "total_loads_hauled": 1,
27    "is_onboarded": false,
28    "carrier_rep_user_id": "usr_00000000-0000-0000-0000-000000000000",
29    "carrier_rep_name": "string",
30    "carrier_rep_email": "string",
31    "is_verified": false,
32    "verified_date": "2024-01-15T09:30:00Z",
33    "created_at": "2024-01-15T09:30:00Z",
34    "updated_at": "2024-01-15T09:30:00Z"
35  },
36  "load_id": "load_00000000-0000-0000-0000-000000000000",
37  "modality": "call",
38  "direction": "outbound",
39  "created_at": "2024-01-15T09:30:00Z",
40  "load_number": "string",
41  "carrier_engaged": true,
42  "call_id": "string",
43  "conversation_id": "string"
44}

Retrieve a single outreach record by ID with carrier and load details.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Create an offer

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

outreach_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Response

Successful Response
idstringformat: "^otr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
carrierobject

v1 carrier response - wraps domain CarrierModel with prefixed IDs.

load_idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
modalityenum

Communication channel: call or email

Allowed values:
directionenum

Direction: inbound or outbound

Allowed values:
created_atdatetime
load_numberstring or null
carrier_engagedboolean or null
call_idstring or null
conversation_idstring or null

Errors

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