Get details of a person
GET {{baseUrl}}/persons/:id?include_fields=<string>&custom_fields=<string>
Returns the details of a specific person. 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 |
---|---|---|---|
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. |
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"}}}