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.

Fixed-size paginated responses

Some Toast API endpoints allow your client to control the number of objects in the response data. In a Toast API endpoint that uses fixed page size response data pagination, you specify:

  • The number of objects in the response data.

  • The first object that the endpoint will return.

Note

Most Toast APIs do not paginate responses using fixed page sizes. If the Toast API endpoint that you are using does not accept the pageSize and page query parameters, that endpoint uses the pagination functionality explained in Page token pagination.