Skip to main content
Production OpenAPI 3.1

​
Connection details

​
Resources

Employees

Master data, account blocking, tenant placement, and division assignment.

Orders

Retrieval, HR approval decisions, products, contract data, and documents.

Incidents

Reporting, server-managed lifecycle state, supported updates, and evidence files.

Divisions

Tenant-owned hierarchy, sibling order, parent relationships, and cost centers.

Payroll exports

Read-only document metadata and available file downloads.

Health

Public basic availability endpoint.

​
Operation matrix

​
Common behavior

Authentication and scope

Protected requests require X-API-Key. The API enforces the key’s tenant and division scope on every resource and reference.
Optional query and header parameters are visible in the reference but are omitted from generated requests until selected.
Supported writes accept dryRun=true and return the documented projection without applying persistence or side effects.
Errors use { "error": { "code", "message", "requestId" } }. The response list on each operation is authoritative.
Reads can be retried under bounded policies. Writes require current-state reconciliation after timeouts or conflicts.

​
Before using an operation

  1. Confirm the API key contains the required scope.
  2. Determine whether X-Tenant-ID is needed.
  3. Review side effects and dry-run support.
  4. Generate and log X-Request-ID.
  5. Handle every documented response status.
  6. Define reconciliation before retrying a write.

Error handling

Map HTTP status, API error code, corrective action, and retryability.

OpenAPI specification

Download the complete machine-readable contract.
Last modified on August 28, 2026