Get all persons
GET {{baseUrl}}/persons?user_id=<integer>&filter_id=<integer>&first_char=<string>&start=0&limit=<integer>&sort=<string>
Returns all persons.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
user_id | string | If supplied, only persons owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied. | |
filter_id | string | The ID of the filter to use | |
first_char | string | If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) | |
start | number | Pagination start | |
limit | string | Items shown per page | |
sort | string | The field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":1,"company_id":12,"owner_id":{"id":123,"name":"Jane Doe","email":"jane@pipedrive.com","has_pic":1,"pic_hash":"2611ace8ac6a3afe2f69ed56f9e08c6b","active_flag":true,"value":123},"org_id":{"name":"Org Name","people_count":1,"owner_id":123,"address":"Mustamäe tee 3a, 10615 Tallinn","active_flag":true,"cc_email":"org@pipedrivemail.com","value":1234},"name":"Will Smith","first_name":"Will","last_name":"Smith","open_deals_count":2,"related_open_deals_count":2,"closed_deals_count":3,"related_closed_deals_count":3,"participant_open_deals_count":1,"participant_closed_deals_count":1,"email_messages_count":1,"activities_count":1,"done_activities_count":1,"undone_activities_count":2,"files_count":2,"notes_count":2,"followers_count":3,"won_deals_count":3,"related_won_deals_count":3,"lost_deals_count":1,"related_lost_deals_count":1,"active_flag":true,"phone":[{"value":"12345","primary":true,"label":"work"}],"email":[{"value":"12345@email.com","primary":true,"label":"work"}],"primary_email":"12345@email.com","first_char":"w","update_time":"2020-05-08 05:30:20","add_time":"2017-10-18 13:23:07","visible_to":"3","marketing_status":"no_consent","picture_id":{"item_type":"person","item_id":25,"active_flag":true,"add_time":"2020-09-08 08:17:52","update_time":"0000-00-00 00:00:00","added_by_user_id":967055,"pictures":{"128":"https://pipedrive-profile-pics.s3.example.com/f8893852574273f2747bf6ef09d11cfb4ac8f269_128.jpg","512":"https://pipedrive-profile-pics.s3.example.com/f8893852574273f2747bf6ef09d11cfb4ac8f269_512.jpg"},"value":4},"next_activity_date":"2019-11-29","next_activity_time":"11:30:00","next_activity_id":128,"last_activity_id":34,"last_activity_date":"2019-11-28","last_incoming_mail_time":"2019-05-29 18:21:42","last_outgoing_mail_time":"2019-05-30 03:45:35","label":1,"label_ids":[1,2,3],"org_name":"Organization name","owner_name":"Jane Doe","cc_email":"org@pipedrivemail.com"}],"additional_data":{"pagination":{"start":0,"limit":100,"more_items_in_collection":false,"next_start":100}},"related_objects":{"organization":{"1":{"id":1,"name":"Org Name","people_count":1,"owner_id":123,"address":"Mustamäe tee 3a, 10615 Tallinn","active_flag":true,"cc_email":"org@pipedrivemail.com"}},"user":{"123":{"id":123,"name":"Jane Doe","email":"jane@pipedrive.com","has_pic":1,"pic_hash":"2611ace8ac6a3afe2f69ed56f9e08c6b","active_flag":true}},"picture":{"1":{"id":1,"item_type":"person","item_id":25,"active_flag":true,"add_time":"2020-09-08 08:17:52","update_time":"0000-00-00 00:00:00","added_by_user_id":967055,"pictures":{"128":"https://pipedrive-profile-pics.s3.example.com/f8893852574273f2747bf6ef09d11cfb4ac8f269_128.jpg","512":"https://pipedrive-profile-pics.s3.example.com/f8893852574273f2747bf6ef09d11cfb4ac8f269_512.jpg"}}}}}