Workers
API for querying and managing worker profiles.
Get worker
Fetch a single worker by ID. Pass `include=credentials` to embed a summary of related credentials in the response (capped at 50). Otherwise the credentials array is omitted entirely.
Replace worker
Replace the worker properties wholesale. Fields absent from the request body are cleared. Use PATCH for partial updates instead.
Soft delete worker
Marks the worker as removed (sets status.removed = true). The underlying record and history are preserved. Hard deletes go through the entity admin API.
Partially update worker
Apply a partial update to worker properties. Only fields present in the request body are modified; unset fields retain their existing values.
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).
Create worker
Create a new worker. The server always generates a synthetic identifier of the form `wkr_<16chars>` — callers cannot supply or override it. Use the `externalId` field on the request body to record an upstream HRIS identifier (e.g. Workday Employee_ID) as a property of the worker. Returns 201 Created with a Location header pointing to the new resource.