Get by handle

GET

/connections/org_profiles/v1/:handle

GET

/connections/org_profiles/v1/:handle

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         environment: "https://localhost:8000",
6     });
7     await client.orgProfiles.getByHandleV1("handle");
8 }
9 main();

Try it

200Retrieved

1 {
2   "courier_org_profile": {
3     "schema_version": 1,
4     "description": "Fast and reliable same-day courier services across the city.",
5     "email_address_primary": "contact@speedycouriers.com",
6     "phone_number_primary": "+1-415-555-0198",
7     "org_id": "org_7f9d3a2b",
8     "_id": "courier_00123"
9   },
10   "forwarder_org_profile": {
11     "schema_version": 1,
12     "description": "Global freight forwarding and logistics solutions tailored to your needs.",
13     "email_address_primary": "support@globalforwarders.com",
14     "phone_number_primary": "+1-212-555-0147",
15     "org_id": "org_4b8c9d7e",
16     "_id": "forwarder_00456"
17   }
18 }

Retrieves a courier or forwarder organization profile using the organization’s handle for public profile viewing. | () -> (OrgProfileRes1)

Path parameters

handlestringRequired

Response

Successful Response

courier_org_profileobject or null

forwarder_org_profileobject or null

Path parameters

Response

Errors