Pagination
In this guide, we will look at how to work with paginated responses when querying the Protocol API. By default, all responses limit results to ten. However, you can go as high as 100 by adding a limit parameter to your requests. If you are using one of the official Protocol API client libraries, you don't need to worry about pagination, as it's all being taken care of behind the scenes.
When an API response returns a list of objects, no matter the amount, pagination is supported. In paginated responses, objects are nested in a data attribute and have a has_more attribute that indicates whether you have reached the end of the last page. You can use the starting_after and endding_before query parameters to browse pages.
Example using cursors
In this example, we request the page that starts after the conversation with id s4WycXedwhQrEFuM. As a result, we get a list of three conversations and can tell by the has_more attribute that we have reached the end of the resultset.
- Name
starting_after- Type
- string
- Description
The last ID on the page you're currently on when you want to fetch the next page.
- Name
ending_before- Type
- string
- Description
The first ID on the page you're currently on when you want to fetch the previous page.
- Name
limit- Type
- integer
- Description
Limit the number of items returned.
Manual pagination using cURL
curl -G https://api.protocol.chat/v1/conversations \
-H "Authorization: Bearer {token}" \
-d starting_after="s4WycXedwhQrEFuM" \
-d limit=10
Paginated response
{
"has_more": false,
"data": [
{
"id": "WAz8eIbvDR60rouK",
// ...
},
{
"id": "hSIhXBhNe8X1d8Et"
// ...
},
{
"id": "fbwYwpi9C2ybt6Yb"
// ...
}
]
}