List credentials
GET/openapi/v1/credentials
Search credentials with optional filters. Owner filter accepts EITHER ownerType+ownerId (synthetic ID) OR ownerType+ownerExternalId (upstream HRIS/ATS ID, optionally narrowed by ownerSourceSystem). Other filters: credentialType, category, jurisdiction, status, eligibility, expiringBefore (ISO 8601 date). 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) in addition to other indexed fields, e.g. sort=lastUpdated:desc. Soft-deleted credentials are excluded by default; pass includeDeleted=true to include them.
Request
Responses
- 200
- 401
- 403
- 429
- 500
OK
Authentication required
Caller is not authorised
Rate limit exceeded — see Retry-After header
Internal server error