List

GET

/orgs/contacts/list/v1

GET

/orgs/contacts/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.contacts.listV1({
8         filter_account_id: "filter_account_id",
9         filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
10         filter_org_id: "filter_org_id",
11         page: 1,
12         page_size: 1,
13         search: "search",
14         sort_by: "name",
15         sort_order: "asc",
16     });
17 }
18 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_by_org_id": "created_by_org_id",
6       "name": "name",
7       "schema_version": 1,
8       "account_ids": [
9         "account_ids"
10       ],
11       "email_address": "email_address",
12       "job_title": "job_title",
13       "location": {
14         "geometry": {
15           "type": "GeometryCollection",
16           "geometries": [
17             {
18               "type": "LineString",
19               "coordinates": [
20                 []
21               ]
22             }
23           ]
24         },
25         "type": "Feature"
26       },
27       "notes": "notes",
28       "off_chrt_org_data_id": "off_chrt_org_data_id",
29       "org_id": "org_id",
30       "phone_number": "phone_number"
31     }
32   ],
33   "total_count": 1
34 }

Lists organization-created contacts with association filters and search. | authz: min_org_role=operator | () -> (ContactListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Full-text search query

filter_org_idstringOptional

Filter by associated on-CHRT organization

filter_off_chrt_org_data_idstringOptional

Filter by associated off-CHRT organization data

filter_account_idstringOptional

Filter by associated account

sort_by"name"Optional

Field to sort by

sort_orderenumOptional

Sort order

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Contacts List V1request Unprocessable Entity Error