Skip to main content

Workers

API for querying and managing worker profiles.

📄️Restore soft-deleted worker

Clears the removed flag (sets status.removed = false) so the worker reappears in list and search results with every preserved aspect intact. The inverse of DELETE. Find restore candidates with `GET /workers?deletedOnly=true`. Idempotent — restoring a worker who is not deleted is a no-op. The worker comes back INACTIVE (the delete paused scanning); PATCH `isActive: true` to resume scheduled verification. Other side effects of the original delete (cancelled fetch requests, resolved review tasks) are not undone; re-request anything still needed after restoring.

📄️List 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).