List by org

GET

/listing/driver_bidding_groups/list_by_org/v1

GET

/listing/driver_bidding_groups/list_by_org/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.listing.driverBiddingGroups.listByOrgV1({
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_created_by_user_id: "filter_created_by_user_id",
13         filter_driver_id: "filter_driver_id",
14         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
15         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
17         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
18     });
19 }
20 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "group_name": "Morning Shift Drivers",
6       "owner_org_id": "org_9f8e7d6c5b4a3",
7       "created_by_user_id": "user_123abc456def",
8       "created_at_timestamp": "2024-01-15T09:30:00Z",
9       "last_edited_at_timestamp": "2024-01-20T14:45:00Z",
10       "_id": "dbg_001a2b3c4d5e6f",
11       "driver_ids": [
12         "driver_789xyz123uvw"
13       ]
14     }
15   ],
16   "total_count": 1
17 }

Lists driver bidding groups owned by the caller’s org with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverBiddingGroupListRes)

Authentication

AuthorizationBearer

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

Query parameters

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

filter_created_by_user_idstringOptional

Filter by the operator who created the group.

filter_driver_idstringOptional

Filter to groups that contain this Driver as a member.

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtedatetimeOptional

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltedatetimeOptional

Filter last_edited_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Driver Bidding Groups List by Org V1request Unprocessable Entity Error