List

GET

/orgs/accounts/list/v1

GET

/orgs/accounts/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.orgs.accounts.listV1({
8         filter_account_id: "filter_account_id",
9         filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
10         filter_org_id: "filter_org_id",
11         page: 1,
12         page_size: 1,
13         search: "search",
14         sort_by: "name",
15         sort_order: "asc",
16     });
17 }
18 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_by_org_id": "created_by_org_id",
6       "created_by_user_id": "created_by_user_id",
7       "name": "name",
8       "schema_version": 1,
9       "location": {
10         "geometry": {
11           "type": "GeometryCollection",
12           "geometries": [
13             {
14               "type": "LineString",
15               "coordinates": [
16                 []
17               ]
18             }
19           ]
20         },
21         "type": "Feature"
22       },
23       "off_chrt_org_data_id": "off_chrt_org_data_id",
24       "org_id": "org_id"
25     }
26   ],
27   "total_count": 1
28 }

Lists coordinator-created shipper accounts with association filters, name search, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (AccountListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Full-text account name search query

filter_account_idstringOptional

Filter by account ID

filter_org_idstringOptional

Filter by associated on-CHRT shipper organization

filter_off_chrt_org_data_idstringOptional

Filter by associated off-CHRT shipper organization data

sort_by"name"Optional

Field to sort by

sort_orderenumOptional

Sort order

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Accounts List V1request Unprocessable Entity Error