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 a load
      • POSTBatch create loads
      • GETList loads
      • GETGet a load
      • PATCHUpdate a load
      • GETGet load statistics
LogoLogo
SupportDashboard
EndpointsLoads

List loads

GET
/loads
GET
/api/v1/loads
$curl https://tryenvoy.ai/api/v1/loads \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": "load_3f2504e0-4f89-11d3-9a0c-0305e82c3301",
5      "load_number": "LD123456789",
6      "organization_id": "org_9a7b3c2d-1f4e-4a6b-8d3f-2c1e5f7a9b0c",
7      "equipment_type": "VAN",
8      "created_at": "2024-05-01T12:00:00Z",
9      "updated_at": "2024-05-15T16:30:00Z",
10      "tms_load_id": "TMS987654321",
11      "external_id": "EXT456789123",
12      "mode": "FTL",
13      "load_status": "Dispatched",
14      "tms_status": "In Transit",
15      "weight": 45000.5,
16      "distance": 1200.75,
17      "commodity": "Electronics",
18      "po_numbers": [
19        "PO1234567"
20      ],
21      "posted_rate": 1500,
22      "max_buy_rate": 1800,
23      "suggested_market_rate": 1700,
24      "length_feet": 53,
25      "special_instructions": [
26        "Handle with care",
27        "No overnight stops"
28      ],
29      "is_posted": true,
30      "temperature_setting_minimum": 35,
31      "temperature_setting_maximum": 45,
32      "temperature_run_type": "Refrigerated",
33      "last_reported_state": "TX",
34      "last_reported_city": "Dallas",
35      "last_reported_long": -96.797,
36      "last_reported_lat": 32.7767,
37      "tms_carrier_id": "CARR123456",
38      "carrier_name": "Swift Transport",
39      "customer_name": "Acme Electronics",
40      "carrier_rep": {
41        "type": "CarrierSalesRep",
42        "first_name": "John",
43        "last_name": "Doe",
44        "phone": "+14155552671",
45        "email": "[email protected]"
46      },
47      "driver": {
48        "type": "Driver",
49        "first_name": "Mike",
50        "last_name": "Smith",
51        "phone": "+14155559876",
52        "email": "[email protected]"
53      },
54      "carrier_rep_user_id": "usr_7e57d004-2b97-0e7a-b45f-5387367791cd",
55      "stops": [
56        {
57          "location": {
58            "city": "Houston",
59            "state": "TX",
60            "street": "1234 Industrial Blvd",
61            "postal_code": "77001",
62            "country": "US",
63            "company_name": "Acme Electronics Warehouse",
64            "county": "Harris",
65            "latitude": 29.7604,
66            "longitude": -95.3698
67          },
68          "stop_number": 1,
69          "is_pickup": true,
70          "is_dropoff": false,
71          "expected_date": "2024-06-10T08:00:00Z",
72          "contact": {
73            "type": "Shipper",
74            "first_name": "Alice",
75            "last_name": "Johnson",
76            "phone": "+12125551234",
77            "email": "[email protected]"
78          },
79          "type": "Pickup",
80          "planned": {
81            "start": "2024-06-10T08:00:00Z",
82            "end": "2024-06-10T10:00:00Z"
83          },
84          "pickup_delivery_number": "PU12345",
85          "contacts": [
86            {
87              "type": "Shipper",
88              "first_name": "Alice",
89              "last_name": "Johnson",
90              "phone": "+12125551234",
91              "email": "[email protected]"
92            }
93          ],
94          "actual_stop_times": {
95            "arrival_datetime": "2024-06-10T08:15:00Z",
96            "departure_datetime": "2024-06-10T09:45:00Z"
97          },
98          "carrier_eta": "2024-06-10T08:00:00Z"
99        },
100        {
101          "location": {
102            "city": "Dallas",
103            "state": "TX",
104            "street": "789 Retail Park Dr",
105            "postal_code": "75201",
106            "country": "US",
107            "company_name": "Retail Corp Distribution Center",
108            "county": "Dallas",
109            "latitude": 32.7767,
110            "longitude": -96.797
111          },
112          "stop_number": 2,
113          "is_pickup": false,
114          "is_dropoff": true,
115          "expected_date": "2024-06-12T14:00:00Z",
116          "contact": {
117            "type": "Receiver",
118            "first_name": "Bob",
119            "last_name": "Williams",
120            "phone": "+13105559876",
121            "email": "[email protected]"
122          },
123          "type": "Dropoff",
124          "planned": {
125            "start": "2024-06-12T13:00:00Z",
126            "end": "2024-06-12T15:00:00Z"
127          },
128          "pickup_delivery_number": "DO67890",
129          "contacts": [
130            {
131              "type": "Receiver",
132              "first_name": "Bob",
133              "last_name": "Williams",
134              "phone": "+13105559876",
135              "email": "[email protected]"
136            }
137          ],
138          "actual_stop_times": {
139            "arrival_datetime": null,
140            "departure_datetime": null
141          },
142          "carrier_eta": "2024-06-12T14:00:00Z"
143        }
144      ],
145      "context": {
146        "priority": "high",
147        "customer_reference": "REF123456"
148      },
149      "custom_fields": {
150        "special_permit": "Hazmat",
151        "insurance_required": true
152      },
153      "offer_count": 3,
154      "max_offer_amount": 1750
155    }
156  ],
157  "pagination": {
158    "page": 1,
159    "page_size": 10,
160    "total_count": 25,
161    "total_pages": 3,
162    "has_next": true,
163    "has_prev": false
164  }
165}

List loads with pagination, search, and sorting. Search matches load number, external ID, TMS load ID, carrier name, customer name, equipment type, and pickup or delivery city/state.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get a load

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

pageintegerOptionalDefaults to 1
page_sizeintegerOptionalDefaults to 10
searchstring or nullOptional
statuslist of enums or nullOptional
order_bystringOptionalDefaults to created_at
order_descbooleanOptionalDefaults to true

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