How to Use Next Page Token

Anne Ramey
Knowledge of how to make an API call

If you have more results than your specified limit, the results to your API query will also contain a nextPageToken:

"nextPageToken": "i0jt7ez0e35d6kkychmigkjge6qsye8j5jy"

This can be used to repeat the query, including the token, to get the next results up to the limit again.

For example, if you wanted all submissions from the services kapp for a form with the slug of contact-us, the query would look something like this:

https://<YOURSERVER>/app/api/v1/kapps/services/forms/contact-us/submissions?timeline=createdAt&direction=DESC&limit=25

Note that the maximum available limit is 1000.

If you were to receive the nextPageToken provided above, you could get the next 25 by going:

https://<YOURSERVER>/app/api/v1/kapps/services/forms/contact-us/submissions?timeline=createdAt&direction=DESC&limit=25&pageToken=i0jvsefrkb2cx3sg6jlv7xn9mnebozutx0n