Get all persons (BETA)
GET {{baseUrl}}/persons/collection?cursor=<string>&limit=<integer>&since=<string>&until=<string>&owner_id=<integer>&first_char=<string>
Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions here.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page | |
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. | |
since | string | The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the update_time field. | |
until | string | The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the update_time field. | |
owner_id | string | If supplied, only persons owned by the given user will be returned | |
first_char | string | If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":1,"active_flag":true,"owner_id":123,"org_id":1234,"name":"Will Smith","phone":[{"value":"12345","primary":true,"label":"work"},{"value":"56789","primary":false,"label":"home"}],"email":[{"value":"12345@email.com","primary":true,"label":"work"}],"update_time":"2023-02-08 05:30:20","delete_time":null,"add_time":"2023-01-08 05:30:20","visible_to":"3","picture_id":12,"label":1,"cc_email":"org@pipedrivemail.com"}],"additional_data":{"next_cursor":"eyJhY3Rpdml0aWVzIjoyN30"}}