List members with drivers

GET

/shipping/drivers/org_members_and_drivers/list/v1

GET

/shipping/drivers/org_members_and_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.listOrgMembersAndDriversV1({
8         search: "search",
9         filter_available_according_to_driver: true,
10         filter_available_according_to_operators: true,
11         sort_by: "first_name",
12         sort_order: "asc",
13         page: 1,
14         page_size: 1,
15     });
16 }
17 main();

1 {
2   "items": [
3     {
4       "org_member": {
5         "role": "owner",
6         "user_id": "user_id",
7         "first_name": null,
8         "last_name": null
9       },
10       "driver": {
11         "schema_version": 1,
12         "_id": "_id",
13         "org_id": "org_id",
14         "user_id": "user_id"
15       }
16     }
17   ],
18   "total_count": 1
19 }

Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search by first or last name

filter_roleenumOptional

Filter by organization role(s)

Allowed values:

filter_available_according_to_driverbooleanOptional

Filter by driver’s self-reported availability.

filter_available_according_to_operatorsbooleanOptional

Filter by operator-set availability.

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Drivers List Org Members and Drivers V1request Unprocessable Entity Error