Four list endpoints return results 25 at a time and are paged with the ?page query parameter. Every paginated response also carries Pagination-* headers and a Link header, so you can walk through pages without tracking offsets yourself.
Usage
To request a specific page of results, include the page parameter in your query string:
Page numbers start at 1. If you omit the parameter, the API returns the first page:
Each page contains up to 25 results.
Supported endpoints
Pagination applies to the following GET endpoints:
/employers/employers/{employerId}/employees/employers/{employerId}/admins/employers/{employerId}/everifyCases
/employers/{employerId}/employees/{employeeId}/submissions is not paginated. It returns every submission for an employee in a single response, because an employee accumulates only a small number of I-9 submissions over the course of employment.
/employees accepts status and includeStatus, and /everifyCases accepts actionRequired. When you filter, the pagination headers describe the filtered set, not the full collection.
Each paginated response includes the following headers to help you navigate pages:
Paginated responses include a Link header with page navigation URLs, using the first, prev, next, and last relations. The prev and next relations are only present when a page exists in that direction, so the last page has no next:
Responses also include a Link header pointing to the current request (self) along with any parent resources related to the request:
To retrieve a full collection, request the first page and follow the next relation until it is no longer present. This avoids assumptions about page size and keeps working if the record count changes between requests.
