List

GET

/users/directory_entries/list/v1

GET

/users/directory_entries/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.users.directoryEntries.listV1({
8         search: "search",
9         filter_entry_org_id: "filter_entry_org_id",
10         sort_by: "company_name",
11         sort_order: "asc",
12         page: 1,
13         page_size: 1,
14     });
15 }
16 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "created_by_org_id": "created_by_org_id",
6       "created_by_user_id": "created_by_user_id",
7       "_id": "_id",
8       "entry_org_id": "entry_org_id",
9       "entry_off_chrt_shipper_org_id": "entry_off_chrt_shipper_org_id",
10       "company_name": "company_name",
11       "industry": "industry",
12       "location": {
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_primary": "email_address_primary",
31       "email_address_secondary": "email_address_secondary",
32       "job_title": "job_title",
33       "notes": "notes"
34     }
35   ],
36   "total_count": 1
37 }

Lists directory entries with pagination, optional filtering by entry_org_id, and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstring or nullOptional

Full-text search query

filter_entry_org_idstring or nullOptional

Filter by the org this entry belongs to

sort_byenum or nullOptional

Field to sort by

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc)

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Directory Entries List V1request Unprocessable Entity Error