Get all persons
GET {{baseUrl}}/persons?filter_id=<integer>&ids=<string>&owner_id=<integer>&org_id=<integer>&updated_since=<string>&updated_until=<string>&sort_by=id&sort_direction=asc&include_fields=<string>&custom_fields=<string>&limit=<integer>&cursor=<string>
Returns data about all persons. Fields ims, postal_address, notes, birthday, and job_title are only included if contact sync is enabled for the company.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter_id | string | If supplied, only persons matching the specified filter are returned | |
ids | string | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. | |
owner_id | string | If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. | |
org_id | string | If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. | |
updated_since | string | If set, only persons with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | |
updated_until | string | If set, only persons with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | |
sort_by | string | The field to sort by. Supported fields: id, update_time, add_time. | |
sort_direction | string | The sorting direction. Supported values: asc, desc. | |
include_fields | string | Optional comma separated string array of additional fields to include. marketing_status and doi_status can only be included if the company has marketing app enabled. | |
custom_fields | string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | |
limit | string | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | |
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":1,"name":"Person Name","first_name":"Person","last_name":"Name","owner_id":1,"org_id":1,"add_time":"2021-01-01T00:00:00Z","update_time":"2021-01-01T00:00:00Z","emails":[{"value":"email1@email.com","primary":true,"label":"work"},{"value":"email2@email.com","primary":false,"label":"home"}],"phones":[{"value":"12345","primary":true,"label":"work"},{"value":"54321","primary":false,"label":"home"}],"is_deleted":false,"visible_to":7,"label_ids":[1,2,3],"picture_id":1,"custom_fields":{},"notes":"Notes from contact sync","im":[{"value":"skypeusername","primary":true,"label":"skype"},{"value":"whatsappusername","primary":false,"label":"whatsapp"}],"birthday":"2000-12-31","job_title":"Manager","postal_address":{"value":"123 Main St","country":"USA","admin_area_level_1":"CA","admin_area_level_2":"Santa Clara","locality":"Sunnyvale","sublocality":"Downtown","route":"Main St","street_number":"123","postal_code":"94085"}}],"additional_data":{"next_cursor":"eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"}}