Get by ID

GET

/users/directory_entries/v1/:directory_entry_id

GET

/users/directory_entries/v1/:directory_entry_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.users.directoryEntries.getV1("directory_entry_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   "schema_version": 1,
6   "company_name": "company_name",
7   "contact_first_name": "contact_first_name",
8   "contact_last_name": "contact_last_name",
9   "email_address_primary": "email_address_primary",
10   "email_address_secondary": "email_address_secondary",
11   "entry_off_chrt_shipper_org_id": "entry_off_chrt_shipper_org_id",
12   "entry_org_id": "entry_org_id",
13   "industry": "industry",
14   "job_title": "job_title",
15   "location": {
16     "geometry": {
17       "type": "GeometryCollection",
18       "geometries": [
19         {
20           "type": "LineString",
21           "coordinates": [
22             []
23           ]
24         }
25       ]
26     },
27     "type": "Feature",
28     "bbox": [
29       {
30         "key": "value"
31       }
32     ],
33     "id": 1,
34     "properties": {
35       "address": "address",
36       "name": "name"
37     }
38   },
39   "notes": "notes",
40   "phone_number_primary": "phone_number_primary",
41   "phone_number_secondary": "phone_number_secondary"
42 }

Retrieves a specific directory entry by ID if authorized to access it. | authz: min_org_role=operator | () -> (DirectoryEntry1)

Authentication

AuthorizationBearer

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

Path parameters

directory_entry_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_

schema_versioninteger

company_namestring

contact_first_namestring

contact_last_namestring

email_address_primarystring

email_address_secondarystring

entry_off_chrt_shipper_org_idstring

entry_org_idstring

Must be a string starting with org_

industrystring

job_titlestring

locationobject

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.

notesstring<=524288 characters

phone_number_primarystring

phone_number_secondarystring

Errors

422

Directory Entries Get V1request Unprocessable Entity Error