List orgs

GET

/orgs/off_chrt_shipper_org/list/v1

GET

/orgs/off_chrt_shipper_org/list/v1

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.offChrtShipperOrg.listV1({
8         search: "search",
9         page: 1,
10         page_size: 1,
11     });
12 }
13 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "email_address_primary": "email_address_primary",
6       "created_by_org_id": "created_by_org_id",
7       "created_by_user_id": "created_by_user_id",
8       "_id": "_id",
9       "company_name": "company_name",
10       "industry": "industry",
11       "department_id": "department_id",
12       "street_address": {
13         "type": "Feature",
14         "geometry": {
15           "type": "GeometryCollection",
16           "geometries": [
17             {
18               "type": "LineString",
19               "coordinates": [
20                 []
21               ]
22             }
23           ]
24         }
25       },
26       "contact_first_name": "contact_first_name",
27       "contact_last_name": "contact_last_name",
28       "phone_number_primary": "phone_number_primary",
29       "phone_number_secondary": "phone_number_secondary",
30       "email_address_secondary": "email_address_secondary",
31       "job_title": "job_title",
32       "notes": "notes",
33       "shipper_customer_id_for_stripe_connect_account": "shipper_customer_id_for_stripe_connect_account"
34     }
35   ],
36   "total_count": 1
37 }

Lists all off-platform shipper organizations created by the caller’s organization with optional search by company name. | () -> (OffChrtShipperOrgListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search by company name

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Off Chrt Shipper Org List V1request Unprocessable Entity Error