List connected providers

GET

/orgs/org_info_for_connections/provider/list/v1

GET

/orgs/org_info_for_connections/provider/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.orgInfoForConnections.provider.listV1();
8 }
9 main();

200Retrieved

1 [
2   {
3     "schema_version": 1,
4     "email_address_primary": "email_address_primary",
5     "provider_org_id": "provider_org_id",
6     "_id": "_id",
7     "industry": "industry",
8     "street_address": {
9       "type": "Feature",
10       "geometry": {
11         "type": "GeometryCollection",
12         "geometries": [
13           {
14             "type": "LineString",
15             "coordinates": [
16               []
17             ]
18           }
19         ]
20       },
21       "id": 1
22     },
23     "contact_first_name": "contact_first_name",
24     "contact_last_name": "contact_last_name",
25     "phone_number_primary": "phone_number_primary",
26     "phone_number_secondary": "phone_number_secondary",
27     "email_address_secondary": "email_address_secondary",
28     "job_title": "job_title",
29     "notes": "notes",
30     "provider_user_id": "provider_user_id"
31   }
32 ]

Retrieves list of provider org info documents for providers connected to the caller. Shippers see providers via shipper_provider_connections; providers see other providers via provider_provider_connections (in either direction). | () -> (list[ProviderOrgInfoForConnections1])

Authentication

AuthorizationBearer

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

Response

Successful Response

schema_versioninteger

email_address_primarystring

provider_org_idstring

Must be a string starting with org_

_idstring

industrystring

street_addressobject

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.

contact_first_namestring

contact_last_namestring

phone_number_primarystring

phone_number_secondarystring

email_address_secondarystring

job_titlestring

notesstring<=524288 characters

provider_user_idstring

Must be a string starting with user_