Get profile

GET

/connections/org_profiles/v1

GET

/connections/org_profiles/v1

1 import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         environment: ChrtEnvironment.Local,
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.orgProfiles.getV1();
9 }
10 main();

Try it

200Retrieved

1 {
2   "courier_org_profile": {
3     "schema_version": 1,
4     "description": "Fast and reliable courier services specializing in last-mile delivery across urban areas.",
5     "email_address_primary": "contact@speedycourier.com",
6     "phone_number_primary": "+1-415-555-0198",
7     "org_id": "org_courier_9274",
8     "_id": "courier_5f8d0d55b54764421b7156c3"
9   },
10   "forwarder_org_profile": {
11     "schema_version": 1,
12     "description": "Global freight forwarding and logistics solutions with expertise in air and sea cargo.",
13     "email_address_primary": "support@globalforwarders.com",
14     "phone_number_primary": "+1-212-555-0147",
15     "org_id": "org_forwarder_4821",
16     "_id": "forwarder_5f8d0d55b54764421b7156c4"
17   }
18 }

Retrieves the courier or forwarder organization profile for the caller’s organization. | () -> (OrgProfileRes1)

Authentication

AuthorizationBearer

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

Response

Successful Response

courier_org_profileobject or null

forwarder_org_profileobject or null