List loads

1	{
2	"data": [
3	{
4	"id": "load_3f2504e0-4f89-11d3-9a0c-0305e82c3301",
5	"load_number": "LD123456789",
6	"organization_id": "org_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
7	"equipment_type": "REEFER",
8	"created_at": "2024-05-01T12:00:00Z",
9	"updated_at": "2024-05-15T15: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": "Frozen Seafood",
18	"po_numbers": [
19	"PO1234567"
20	],
21	"posted_rate": 3500,
22	"max_buy_rate": 4000,
23	"suggested_market_rate": 3750,
24	"length_feet": 53,
25	"special_instructions": [
26	"Handle with care",
27	"Keep refrigerated at all times"
28	],
29	"is_posted": true,
30	"temperature_setting_minimum": -10,
31	"temperature_setting_maximum": 0,
32	"temperature_run_type": "Continuous",
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": "Oceanic Foods Inc.",
40	"carrier_rep": {
41	"type": "CarrierSalesRep",
42	"first_name": "Emily",
43	"last_name": "Johnson",
44	"phone": "+14155552671",
45	"email": "[email protected]"
46	},
47	"driver": {
48	"type": "Driver",
49	"first_name": "Carlos",
50	"last_name": "Martinez",
51	"phone": "+14155559876",
52	"email": "[email protected]"
53	},
54	"carrier_rep_user_id": "usr_9f8e7d6c-5b4a-3210-9f8e-7d6c5b4a3210",
55	"stops": [
56	{
57	"location": {
58	"city": "Houston",
59	"state": "TX",
60	"street": "123 Harbor St",
61	"postal_code": "77002",
62	"country": "US",
63	"company_name": "Oceanic Foods Inc.",
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": "Linda",
75	"last_name": "Smith",
76	"phone": "+14155551234",
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": "PU123456",
85	"contacts": [
86	{
87	"type": "Shipper",
88	"first_name": "Linda",
89	"last_name": "Smith",
90	"phone": "+14155551234",
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": "Chicago",
103	"state": "IL",
104	"street": "789 Market Ave",
105	"postal_code": "60601",
106	"country": "US",
107	"company_name": "Fresh Markets Distribution",
108	"county": "Cook",
109	"latitude": 41.8781,
110	"longitude": -87.6298
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": "James",
119	"last_name": "Lee",
120	"phone": "+12125551234",
121	"email": "[email protected]"
122	},
123	"type": "Dropoff",
124	"planned": {
125	"start": "2024-06-12T14:00:00Z",
126	"end": "2024-06-12T16:00:00Z"
127	},
128	"pickup_delivery_number": "DL654321",
129	"contacts": [
130	{
131	"type": "Receiver",
132	"first_name": "James",
133	"last_name": "Lee",
134	"phone": "+12125551234",
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	"notes": "Customer requested expedited handling"
148	},
149	"custom_fields": {
150	"internal_code": "XJ-2024-06",
151	"special_permit": "Hazmat"
152	},
153	"offer_count": 3,
154	"max_offer_amount": 4200
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, sorting, and column filters. Search matches load number, external ID, TMS load ID, carrier name, customer name, equipment type, and pickup/delivery city/state. The tab param applies one of the existence-subquery filters used by the loads-page tab strip.

Authentication: Supports API key and bearer token authentication.

List loads with pagination, search, sorting, and column filters. Search matches load number, external ID, TMS load ID, carrier name, customer name, equipment type, and pickup/delivery city/state. The ``tab`` param applies one of the existence-subquery filters used by the loads-page tab strip. **Authentication:** Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptionalDefaults to 1

page_sizeintegerOptionalDefaults to 10

searchstring or nullOptional

statuslist of enums or nullOptional

modelist of enums or nullOptional

Allowed values:

equipment_typelist of enums or nullOptional

customer_namelist of strings or nullOptional

carrier_rep_namestring or nullOptional

Filter by assigned carrier rep name

origin_citystring or nullOptional

Substring match on origin stop city (ILIKE)

destination_citystring or nullOptional

Substring match on destination stop city (ILIKE)

pickup_date_fromdate or nullOptional

pickup_date_todate or nullOptional

delivery_date_fromdate or nullOptional

delivery_date_todate or nullOptional

distance_mindouble or nullOptional>=0

distance_maxdouble or nullOptional>=0

posted_rate_mininteger or nullOptional>=0

posted_rate_maxinteger or nullOptional>=0

tabenum or nullOptional

Tab filter used by the loads list view.

Each value maps to an existence-subquery condition applied on top of the standard load filters. ALL is the no-op default.

ACTIVE_ESCALATIONS is reserved for an upcoming product workflow; the API surfaces it so the front-end can render the full tab strip from day one, but the backend returns 0 / no rows until the feature lands.

Tab filter used by the loads list view. Each value maps to an existence-subquery condition applied on top of the standard load filters. ``ALL`` is the no-op default. ``ACTIVE_ESCALATIONS`` is reserved for an upcoming product workflow; the API surfaces it so the front-end can render the full tab strip from day one, but the backend returns 0 / no rows until the feature lands.

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

$	curl https://tryenvoy.ai/api/v1/loads \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

Authentication

Headers

Query parameters

Response

Errors