List

GET

/shipping/drivers/list/v1

GET

/shipping/drivers/list/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.drivers.listV1({
8         sort_order: "asc",
9         page: 1,
10         page_size: 1,
11         search: "search",
12         filter_available_according_to_driver: true,
13         filter_available_according_to_operators: true,
14     });
15 }
16 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "_id": "driver_8f14e45fceea167a5a36dedd4bea2543",
6       "org_id": "org_9b74c9897bac770ffc029102a200c5de",
7       "user_id": "user_45c48cce2e2d7fbdea1afc51c7c6ad26",
8       "email_address_primary": "jane.doe@logisticsco.com",
9       "email_address_secondary": "j.doe.personal@gmail.com",
10       "phone_number_primary": "+1-415-555-0198",
11       "phone_number_secondary": "+1-415-555-0123",
12       "first_name": "Jane",
13       "last_name": "Doe",
14       "vehicle_types": [
15         "cargo_van",
16         "box_truck"
17       ],
18       "status": "assigned",
19       "available_according_to_driver": true,
20       "available_according_to_operators": false,
21       "waiting": false,
22       "auto_assign_enabled": true,
23       "active_task_group_ids": [
24         "taskgroup_00123"
25       ],
26       "last_seen_at_location": {
27         "type": "Feature",
28         "geometry": {
29           "type": "GeometryCollection",
30           "geometries": [
31             {
32               "type": "LineString",
33               "coordinates": [
34                 [
35                   -122.4194,
36                   37.7749
37                 ],
38                 [
39                   -122.418,
40                   37.7755
41                 ],
42                 [
43                   -122.417,
44                   37.776
45                 ]
46               ]
47             }
48           ]
49         }
50       },
51       "last_seen_at_timestamp": "2024-06-05T14:22:00Z"
52     }
53   ],
54   "total_count": 1
55 }

Lists all drivers belonging to the caller’s organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query

filter_available_according_to_driverbooleanOptional

Filter by driver’s self-reported availability

filter_available_according_to_operatorsbooleanOptional

Filter by operator-set availability

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Drivers List V1request Unprocessable Entity Error