Pagination

How to paginate through lists of resources

Overview

List endpoints use cursor-based pagination. The cursor is returned in the X-Page-Next response header.

Query Parameters

page-size · integer

Number of items to return per page (default varies by endpoint)

page-continue · string

Cursor token from the previous response’s X-Page-Next header

Response Headers

X-Page-Next · string

Cursor token for the next page. Present when more results are available, absent when you’ve reached the last page.

Example

First Page

curl "https://api.getredo.com/v2.2/stores/store_123/returns?page-size=50" \
  -H "Authorization: Bearer YOUR_API_SECRET" \
  -v

Response:

HTTP/1.1 200 OK
X-Page-Next: eyJjcmVhdGVkQXQiOiIyMDIzLTA4LTE4VDEyOjAwOjAwWiJ9

{ "returns": [...] }

Next Page

curl "https://api.getredo.com/v2.2/stores/store_123/returns?page-size=50&page-continue=eyJjcmVhdGVkQXQiOiIyMDIzLTA4LTE4VDEyOjAwOjAwWiJ9" \
  -H "Authorization: Bearer YOUR_API_SECRET"

Paginating All Results

async function getAllReturns(storeId) {
  const allReturns = [];
  let cursor = null;

  do {
    const url = new URL(`https://api.getredo.com/v2.2/stores/${storeId}/returns`);
    url.searchParams.set('page-size', '100');
    if (cursor) {
      url.searchParams.set('page-continue', cursor);
    }

    const response = await fetch(url, {
      headers: { 'Authorization': `Bearer ${process.env.REDO_API_SECRET}` }
    });

    const data = await response.json();
    allReturns.push(...data.returns);

    cursor = response.headers.get('X-Page-Next');
  } while (cursor);

  return allReturns;
}

Notes

• Cursors are opaque tokens - don’t decode or modify them
• Use the exact value from X-Page-Next without modification
• Fetch pages sequentially, not in parallel