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
      • GETTab counts for the loads list
      • GETGet calls for a load
      • GETGet failed carrier verifications for a load
      • GETGet active escalations for a load
      • GETList webhook endpoints
      • POSTRegister a webhook endpoint
      • GETGet a webhook endpoint
      • DELDelete a webhook endpoint
      • PATCHUpdate a webhook endpoint
      • POSTRotate the signing secret
      • GETList delivery attempts for an endpoint
      • GETList attempts for a logical message
      • POSTReplay a delivery
      • GETList subscribable event types
LogoLogo
SupportDashboard
EndpointsAPI

Get calls for a load

GET
/loads/:load_id/calls
GET
/api/v1/loads/:load_id/calls
$curl https://tryenvoy.ai/api/v1/loads/load_id/calls \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1[
2  {
3    "id": "call_3f8a1c2e-7b4d-4f9a-9d2e-1a2b3c4d5e6f",
4    "status": "COMPLETED",
5    "call_time": "2024-04-20T14:45:00Z",
6    "created_at": "2024-04-20T14:45:00Z",
7    "updated_at": "2024-04-20T14:51:00Z",
8    "call_direction": "INBOUND",
9    "phone_number": "+14155552671",
10    "to_number": "+14155550001",
11    "from_number": "+14155552671",
12    "call_start_time": "2024-04-20T14:45:05Z",
13    "call_end_time": "2024-04-20T14:50:30Z",
14    "call_type": "Customer Support",
15    "load_id": "load_9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
16    "organization_id": "org_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
17    "created_by_id": "usr_0f1e2d3c-4b5a-6978-8c9d-0e1f2a3b4c5d",
18    "recording_status": "AVAILABLE",
19    "load_number": "LD123456789"
20  }
21]

Return every phone call attached to this load, newest first.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get failed carrier verifications for a load

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

load_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Response

Successful Response
idstringformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
statusenum
call_timedatetime
created_atdatetime
updated_atdatetime
call_directionenum or null
Allowed values:
phone_numberstring or null

Customer phone number (derived from direction)

to_numberstring or null
from_numberstring or null
call_start_timedatetime or null
call_end_timedatetime or null
call_typestring or null
load_idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
organization_idstringformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
created_by_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
recording_statusstring or null
load_numberstring or null

Errors

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