Skip to main content
GET

Pagination

This endpoint supports pagination to efficiently retrieve large employee lists. Use the page and limit query parameters to control the results.
  • page: Page number (default: 1)
  • limit: Number of items per page (default: 10, maximum: 100)

Use Case

  • Display list of employees in UI with pagination
  • Select employees for contribution submission
  • Verify which employees are onboarded
  • Efficiently browse through large employee databases

Request Parameters

integer
Page number for pagination (default: 1)
integer
Number of items per page (default: 10, max: 100)

Responses

Response fields

array
List of employees. Each employee object matches the Employee response model from GET /v1/employees/{id} and may include optional superannuation identifiers (usi, memberNumber, employmentPayrollNumber, abn).
number
Total count of employees across all pages
number
Total number of pages available
boolean
Whether there is a next page available
boolean
Whether there is a previous page available
boolean
Always false for error responses, indicating the operation did not succeed.
integer
HTTP status code indicating the type of error. Common values: 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Server Error)
string
Human-readable error message explaining what went wrong. May include specific details about which field or value caused the error.
integer
Superannuation clearing house-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes. Common codes: 4030 (Employer not found), 4031 (Invalid ABN), 4040 (Fund not found).
Last modified on November 10, 2026