Pagination
The pagination is handled by using a “next token” mechanism. This means that, in order to retrieve the next page of results, you have to send the token returned in the previous page result.
This implies that, if you don’t send any token, the page that will always return is the first one. And if you don’t get any token with the current page’s result is because you reached the last page.
First Page Call
Let’s start by requesting the first page. Make sure you don’t send any next token in the query parameters.
Receive the first page as a result. Notice how now there is a next token returned in the JSON response. This is the token that you will use if you want to retrieve the second page.
Next Page Call
Now you are able to request for the second page. Make sure to send the next token that was returned with the first page result.
Receive the second page as a result. Notice how a new next token is returned. This new token has to be sent in order to request for the third page.
The process must be repeated to access the other pages one after one.
Last Page Call
When you stop receiving a new token, it means that you reached the last page of all the results available.
If you try to send no token to the next request you will return to the “First Page Call” scenario, giving you the possibility to start again from the first page.
One Page Call
There may be cases in which the first page is also the last one. This is because the number of results is not enough to surpass the page size defined in the internal pagination configuration for this resource.
What will happen in this case is that you will attempt to request for the first page by not sending any token and the result will come with no token as well. Meaning that you already retrieved all the results in just one page.
If you try to send no token to the next request you will return to the “First Page Call” scenario, giving you the possibility to start again from the first page.
