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 an ELP assessment call
      • GETList ELP assessment tests
      • GETGet an ELP test
LogoLogo
SupportDashboard
EndpointsELP

List ELP assessment tests

GET
/elp/tests
GET
/api/v1/elp/tests
$curl https://tryenvoy.ai/api/v1/elp/tests \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "id": "elp_00000000-0000-0000-0000-000000000000",
5      "status": "REQUESTED",
6      "created_at": "2024-01-15T09:30:00Z",
7      "call_id": "call_00000000-0000-0000-0000-000000000000",
8      "carrier_id": "car_00000000-0000-0000-0000-000000000000",
9      "phone_number": "string",
10      "driver_name": "string",
11      "carrier_name": "string",
12      "mc_number": "string",
13      "scoring_status": "PENDING",
14      "conversational_communication": 1,
15      "instruction_comprehension": 1,
16      "sign_recognition": 1,
17      "verbal_reporting": 1,
18      "total_score": 1,
19      "total_questions": 1,
20      "questions_answered": 1,
21      "valid_answers": 1,
22      "notes": "string",
23      "call": {
24        "id": "call_00000000-0000-0000-0000-000000000000",
25        "status": "string",
26        "call_time": "2024-01-15T09:30:00Z",
27        "created_at": "2024-01-15T09:30:00Z",
28        "updated_at": "2024-01-15T09:30:00Z",
29        "call_direction": "string",
30        "phone_number": "string",
31        "to_number": "string",
32        "from_number": "string",
33        "call_start_time": "2024-01-15T09:30:00Z",
34        "call_end_time": "2024-01-15T09:30:00Z",
35        "transcript": [
36          {
37            "role": "string",
38            "content": "string",
39            "id": "string",
40            "timestamp": "string",
41            "interrupted": true,
42            "transcript_confidence": 1.1,
43            "tool_calls": [
44              {
45                "id": "",
46                "type": "",
47                "function": {
48                  "name": "",
49                  "arguments": null
50                }
51              }
52            ],
53            "tool_call_id": "string"
54          }
55        ]
56      }
57    }
58  ],
59  "pagination": {
60    "page": 1,
61    "page_size": 1,
62    "total_count": 1,
63    "total_pages": 1,
64    "has_next": true,
65    "has_prev": true
66  }
67}

Retrieve ELP assessment tests for your organization. Each test spans the full lifecycle (REQUESTED → COMPLETED → SCORED) with the associated call and transcript when available.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get an ELP test

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

phone_numberstring or nullOptional

Filter by driver phone number (E.164)

mc_numberstring or nullOptional
Filter by carrier MC number
call_idstring or nullOptionalformat: "uuid"
Filter by call ID
pageintegerOptional>=1Defaults to 1

Page number (1-indexed)

page_sizeintegerOptional1-100Defaults to 20
Items 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