List

GET

/operations/departments/list/v1

GET

/operations/departments/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.operations.departments.listV1({
8         sort_by: "created_at",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12     });
13 }
14 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "name": "name",
6       "department": "automotive",
7       "_id": "_id",
8       "org_id": "org_id",
9       "created_by_user_id": "created_by_user_id",
10       "created_at": "2024-01-15T09:30:00Z",
11       "location": {
12         "type": "Feature",
13         "geometry": {
14           "type": "GeometryCollection",
15           "geometries": [
16             {
17               "type": "LineString",
18               "coordinates": [
19                 []
20               ]
21             }
22           ]
23         }
24       },
25       "operator_user_ids": [
26         "operator_user_ids"
27       ]
28     }
29   ],
30   "total_count": 1
31 }

Lists department configurations for the caller’s organization. | authz: min_org_role=operator | () -> (DepartmentListRes)

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_departmentenumOptional

Filter by department(s)

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Departments List V1request Unprocessable Entity Error