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 an offer
      • GETList offers
      • GETGet an offer
      • PATCHUpdate an offer
LogoLogo
SupportDashboard
EndpointsOffers

List offers

GET
/offers
GET
/api/v1/offers
$curl https://tryenvoy.ai/api/v1/offers \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": "ofr_3f9a1b2c-4d5e-6789-abcd-1234567890ef",
5      "tms_load_id": "TMS123456789",
6      "load_id": "load_7a8b9c0d-1e2f-3456-789a-bcdef0123456",
7      "offer_amount": 1250.75,
8      "status": "pending",
9      "source": "web_portal",
10      "created_at": "2024-01-15T09:30:00Z",
11      "updated_at": "2024-01-15T09:30:00Z",
12      "carrier_id": "car_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
13      "contact_id": "con_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
14      "call_id": "call_0a1b2c3d-4e5f-6789-abcd-ef0123456789",
15      "email_message_id": "MSG-20240115-093000-001",
16      "notes": "Offer valid for 48 hours. Includes fuel surcharge.",
17      "created_by_id": "usr_123e4567-e89b-12d3-a456-426614174000",
18      "updated_by_id": "usr_123e4567-e89b-12d3-a456-426614174000",
19      "load_number": "LOAD-20240115-001",
20      "carrier": {
21        "id": "car_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
22        "name": "Swift Logistics LLC",
23        "mc_number": "MC123456",
24        "dot_number": "DOT654321",
25        "email": "[email protected]",
26        "phone": "+1-555-123-4567",
27        "dispatcher_name": "Jane Doe",
28        "dispatcher_phone": "+1-555-987-6543",
29        "dispatcher_email": "[email protected]",
30        "is_active": true,
31        "provider": "EnvoyAI",
32        "ingestion_method": "API",
33        "equipment_types": [
34          "VAN",
35          "REEFER"
36        ],
37        "insurance_expiration": "2024-12-31T23:59:59Z",
38        "w9_on_file": true,
39        "authorized_for_hire": true,
40        "on_time_pickup_pct": 98.5,
41        "on_time_delivery_pct": 97.2,
42        "tracking_compliance_pct": 95,
43        "avg_response_time_min": 15.3,
44        "total_loads_hauled": 350,
45        "is_onboarded": true,
46        "carrier_rep_user_id": "usr_789e1234-b56c-78d9-e012-3456789abcde",
47        "carrier_rep_name": "John Smith",
48        "carrier_rep_email": "[email protected]",
49        "is_verified": true,
50        "verified_date": "2023-11-01T08:00:00Z",
51        "created_at": "2022-05-10T10:00:00Z",
52        "updated_at": "2024-01-10T12:00:00Z"
53      },
54      "contact_name": "Emily Johnson",
55      "contact_phone": "+1-555-234-5678",
56      "email_conversation_id": "conv_20240115_093000",
57      "rep_name": "Michael Lee"
58    }
59  ],
60  "pagination": {
61    "page": 1,
62    "page_size": 1,
63    "total_count": 25,
64    "total_pages": 25,
65    "has_next": true,
66    "has_prev": false
67  }
68}

Get offers for the organization. Optionally filter by load or call.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get an offer

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 offers by load ID
call_idstring or nullOptionalformat: "uuid"
Filter offers by call ID
pageintegerOptional>=1Defaults to 1
Page number
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