This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Paginated response header field and query parameter

When you interact with an endpoint that has paginated results, you use the following header field and query parameter:

Toast-Next-Page-Token

A response header field that identifies the following set of objects that the endpoint will return. This value is a string that you use in the pageToken query parameter in a following request.

pageToken

A query parameter that controls the first object that the endpoint returns in its response data. You get the string value of this parameter from the Toast-Next-Page-Token header field in the response to a previous request.

Some Toast API endpoints paginate responses in a way that returns a fixed number of result data objects in each page. If the endpoint you are using includes the pageSize and page query parameters, the endpoint uses fixed-size response data pagination. For more information, see Fixed-size paginated responses.