Skip to main content
List endpoints that support paging use the same request parameters and response container as the account API. This is the contract for current and future OpenAPI lists. The published OpenAPI list surface is small today. For example, Get Thank You promo offers returns { "offers": [...] } and does not use this paging contract. There are no cursor tokens and no X-Page-Next (or similar) pagination headers.

Request

Send these parameters on list endpoints that support paging: Do not assume a hardcoded default pageSize. If you need a specific page size, send pageSize on the request.

Response

Paged responses use this container:

Walking pages

1

Request the first page

Call the list endpoint with pageIndex=1. Include pageSize if you want a specific page size.
2

Collect items

Append data to your result set. totalRows is the full match count.
3

Increment pageIndex

Request the next page until you have collected totalRows items, the current page returns no items, or — when you sent pageSize — the page contains fewer items than pageSize.