List workers
GET/openapi/v1/workers
Search and filter workers. Returns paginated results sorted by display name ascending unless overridden. Use the query parameter for free-text search, or externalId to look up by upstream identifier (HRIS / source-system ID). Filter by record recency with updatedAfter and/or updatedBefore (ISO 8601 instant, e.g. 2026-01-01T00:00:00Z, or a bare date 2026-01-01); updatedAfter is inclusive, updatedBefore is exclusive. Sort by lastUpdated (record last-modified time), e.g. sort=lastUpdated:desc. Soft-deleted workers are excluded by default; pass includeDeleted=true to see them as well (admin / audit / recovery flows).
Request
Responses
- 200
- 401
- 403
- 429
- 500
OK
Authentication required
Caller is not authorised
Rate limit exceeded — see Retry-After header
Internal server error