Get off-CHRT organization data

GET

/orgs/off_chrt_org_data/v1/:off_chrt_org_data_id

GET

/orgs/off_chrt_org_data/v1/:off_chrt_org_data_id

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.getByIdV1("off_chrt_org_data_id");
8 }
9 main();

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

Gets owner-scoped off-CHRT organization data by ID. | authz: allowed_org_types=[provider] | () -> (OffChrtOrgData1)

Authentication

AuthorizationBearer

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

Path parameters

off_chrt_org_data_idstringRequired

Response

Successful Response

_idstring

created_by_user_idstring

Must be a string starting with user_

namestring1-255 characters

org_typeenum

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

email_addressstringOptional

industrystringOptional

phone_numberstringOptional

street_addressobjectOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

Errors

422

Off Chrt Org Data Get by ID V1request Unprocessable Entity Error