Pagination

All list endpoints in the Diversity Sync API are paginated. You control the page with the page and pageSize query parameters, and each response echoes them back alongside the array of results.

By default, list endpoints return the first page with a pageSize of 25. You can request up to 100 results per page. Results are nested under a resource-named key (for example staff or participants), and the response repeats the page and pageSize it served.

Example

Here we request the second page of staff, 50 per page.

Name
page
Type
integer
Description
The page to return, starting at 1. Defaults to 1.
Name
pageSize
Type
integer
Description
The number of items per page (1–100). Defaults to 25.

Manual pagination using cURL

curl -G https://api.diversitysync.com/v1/staff \
  -H "Authorization: Bearer {access_token}" \
  -d page=2 \
  -d pageSize=50

Paginated response

{
  "page": 2,
  "pageSize": 50,
  "staff": [
    {
      "id": 482,
      "name": "Jordan Avery"
      // ...
    },
    {
      "id": 491
      // ...
    }
  ]
}

To page through a full result set, increment page until a response returns fewer than pageSize items — that's the last page.