Pagination allows a listing endpoint to return a subset of results. The goal is to reduce memory usage and speed up page rendering.
To retrieve the next page, a pageKey
can be supplied. Typically this will be the nextPageKey
returned from your previous query.
Please note that when making a request, the values of pageKey
must be URL-encoded. This ensures proper handling of special characters and encoding requirements.
Some of our endpoints have been designed to be forwards compatible with pagination. When we do bring support to GET endpoints for listing, these conventions will be followed.
Attributes
-
items
-
nextPageKey
/api/examples
Attributes
-
pageKey
Request
curl -X GET \
'https://service.centrapay.com/api/examples?pageKey=Example%23E9eXsErwA444qFDoZt5iLA%7CActivity%23000000000000001%7C614161c4c4d3020073bd4ce8' \
-H 'x-api-key: <TOKEN>'
Response
{
"nextPageKey": "5ee0c486308f590260d9a07f|ded3f328-1123-11ec-bf1a-5ba46eb12a7d",
"items": [
{
"value": "16",
"assetType": "centrapay.nzd.main"
},
{
"value": "32",
"assetType": "centrapay.nzd.main"
},
{
"value": "64",
"assetType": "centrapay.nzd.main"
}
]
}