Get by ID

GET

/orgs/accounts/v1/:account_id

GET

/orgs/accounts/v1/:account_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.accounts.getV1("account_id");
8 }
9 main();

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

Retrieves a coordinator-created shipper account. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Account1)

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Response

Successful Response

_idstring

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

namestring1-255 characters

schema_versioninteger

locationobjectOptional

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.

off_chrt_org_data_idstringOptional

org_idstringOptional

Must be a string starting with org_

Errors

422

Accounts Get V1request Unprocessable Entity Error