Pagination
All GET endpoints that return lists of records support pagination via the ?page query parameter.
Usage
To request a specific page of results, include the page parameter in your query string:
https://api.symmetry.com/i9/v1/employers/12345678/employees?page=2
If the page parameter is not specified, the API will default to:
?page=1
Each page contains 25 results.
Supported Endpoints
Pagination applies to the following GET all endpoints:
/employers/employers/{employerId}/employees/employers/{employerId}/employees/{employeeId}/submissions/employers/{employerId}/admins/employers/{employerId}/everifyCases
Response Headers
Each paginated response includes the following headers to help navigate pages:
| Header name | Header description | Example value |
|---|---|---|
Pagination-Page | Current page | 2 |
Pagination-PageItemCount | Total results returned on that page (Pagination-Page) | 2 |
Pagination-PageItemLimit | Page size | 25 |
Pagination-TotalCount | Total results | 27 |
Pagination-TotalPages | Number of page results | 2 |
Link | Provide URLs showing the page navigation | </i9/v1/employers/01971d41-b29d-75cf-a308-15ca267af31c/employees?page=1>; rel="first", </i9/v1/employers/01971d41-b29d-75cf-a308-15ca267af31c/employees?page=1>; rel="prev", </i9/v1/employers/01971d41-b29d-75cf-a308-15ca267af31c/employees?page=2>; rel="last" |
Link | Provides URLs to the current request 'self'. Also gives URLs to any parent objects related to this request. | </i9/v1/employers/01971d41-b29d-75cf-a308-15ca267af31c/employees>; rel="self", </v1/employers/01971d41-b29d-75cf-a308-15ca267af31c>; rel="employer" |
Updated about 18 hours ago
