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.

Response pagination types used by Toast APIs

The following table identifies the pagination functionality used by Toast API endpoints.

API and endpoint

Response pagination used

Configuration API

All endpoints that return paginated response data use page token pagination. For more information, see Page token pagination.

Note

Configuration API endpoints previously used fixed-size pagination for response data. The parameters for using fixed-size pagination are still supported, but fixed-size pagination is deprecated for configuration API endpoints.

As of 2021-12-06, configuration API endpoints no longer support fixed-size pagination and only support page token pagination. For more information about this and other changes to Toast APIs, see Integration Update Schedule.

Kitchen API

All endpoints that return paginated response data use page token pagination for response data.

For more information, see Page token pagination.

Orders API /ordersBulk endpoint

The orders API /ordersBulk endpoint uses fixed-size pagination.

For more information, see Fixed-size paginated responses.