Get by handle

GET

/orgs/org_public_data/by_handle/v1/:handle

GET

/orgs/org_public_data/by_handle/v1/:handle

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.publicData.getByHandleV1("handle");
8 }
9 main();

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

Retrieves public organization data by handle. | () -> (OrgPublicData1)

Authentication

AuthorizationBearer

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

Path parameters

handlestringRequired

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

Response

Successful Response

_idstring

namestring1-255 characters

org_idstring

Must be a string starting with org_

org_typeenum

schema_versioninteger

descriptionstring or nullOptional<=524288 characters

email_addressstring or nullOptional

handlestring or nullOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

industrystring or nullOptional

phone_numberstring or nullOptional

street_addressobject or nullOptional

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

Public Data Get by Handle V1request Unprocessable Entity Error