We are happy to announce 2 new cursor-paginated endpoints for Persons and Organizations API to offer a fast and performant way for querying large sets of items:

• GET /persons/collection – for querying all persons
• GET /organizations/collection – for querying all organizations

As these endpoints are released in Beta, we are interested in hearing about your experience using them! Let us know of any feedback in the Developers' Community.

If, based on the feedback, anything is changed in the behavior of these endpoints during the Beta period, we will announce this in the Community thread.

The pagination logic for these endpoints is controlled by the cursor and limit query parameters:

• cursor – a marker representing the first item on the next page
• limit – the limit of entries to be returned

Within the response’s additional_data object, the next_cursor field is returned, indicating the first item on the next page.

Please note that only global admins (users with global permissions) can access these endpoints. Users with regular permissions will receive a 403 error response.

Here's an example response schema for the GET /persons/collection endpoint:

{
    "success": true,
    "data": [
        {
            "id": 1,
            "active_flag": true,
            "owner_id": 123,
            "org_id": 1234,
            "name": "Will Smith",
            "phone": [
                {
                    "value": "12345",
                    "primary": true,
                    "label": "work"
                }
            ],
            "email": [
                {
                    "value": "[email protected]",
                    "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": "[email protected]"
        }
    ],
    "additional_data": {
        "next_cursor": "eyJhY3Rpdml0aWVzIjoyN30"
    }
}

For additional information about pagination in the Pipedrive API, please refer to our developer documentation here.

What is the benefit of the new endpoints?

Until now, most of the GET endpoints of Pipedrive’s API have supported offset-based pagination. We are introducing the two new GET endpoints with cursor-based pagination to ensure reliable response times and a better experience when paging through large sets of entities.

You can check out the previously announced Activities and Deals API cursor-based endpoints here:

• GET /activities/collection
• GET /deals/collection