List off-CHRT organization data

GET

/orgs/off_chrt_org_data/list/v1

GET

/orgs/off_chrt_org_data/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.offChrtOrgData.listV1({
8         filter_org_type: "provider",
9         page: 1,
10         page_size: 1,
11         search: "search",
12         sort_by: "name",
13         sort_order: "asc",
14     });
15 }
16 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_by_user_id": "created_by_user_id",
6       "name": "name",
7       "org_type": "provider",
8       "owned_by_org_id": "owned_by_org_id",
9       "schema_version": 1,
10       "email_address": "email_address",
11       "industry": "industry",
12       "phone_number": "phone_number",
13       "street_address": {
14         "geometry": {
15           "type": "GeometryCollection",
16           "geometries": [
17             {
18               "type": "LineString",
19               "coordinates": [
20                 []
21               ]
22             }
23           ]
24         },
25         "type": "Feature"
26       }
27     }
28   ],
29   "total_count": 1
30 }

Lists off-CHRT organization data owned by the caller with optional organization-type filtering, identity search, sorting, and pagination. | authz: allowed_org_types=[provider] | () -> (OffChrtOrgDataListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search by name, industry, or email

filter_org_typeenumOptional

Allowed values:

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

Off Chrt Org Data List V1request Unprocessable Entity Error