Employees

Employees are customer-scoped master-data resources. The Public API supports list, create, get, and partial update operations.

Capabilities

Capability	Supported	Notes
List and filter employees	Yes	Across all key tenants or one selected tenant
Create employee	Yes	Sends password setup email on real create
Update supported fields	Yes	Patch only changed fields
Change work email	No	Not patchable through public update
Move division	Yes	Within the same tenant and allowed scope
Transfer tenant	No	Not exposed for assigned employees
Block or unblock	Yes	Through `blocked`
Delete employee	No	No public delete operation

Page, filter, sort, and restrict employee collections.

Validate placement and create an account.

Retrieve one employee by opaque ID.

Patch supported fields, division assignment, and blocking state.

Store the JobHandy employee ID after match or create.
Use a stable customer identifier such as employeeNumber where uniqueness is guaranteed.
Do not use email as the only long-term key unless the customer guarantees immutability.
Omit patch fields that should remain unchanged.
Use null only for nullable fields that should be cleared.
Do not use a dry-run preview ID in later requests.

Implement identity matching, checkpoints, dry runs, partial updates, and timeout reconciliation.

Last modified on August 27, 2026