Contract version
2.0.0 introduces breaking changes to incident creation and employee patches. Read the migration guidance.Available capabilities
Not exposed by public v1
The current contract does not define public operations for:- tenant creation, update, or deletion
- API-key management through the API
- employee deletion
- changing an employee’s work email through the employee patch operation
- transferring an assigned employee to another tenant through employee patch
- order creation
- changing a final order decision through the decision endpoint
- incident deletion or reopening
- division deletion
- payroll export generation or deletion
- general idempotency keys
- bulk mutation endpoints
- multiple sort fields
- webhook registration or public event subscriptions
- a public stage or sandbox base URL
Important behavioral limitations
dryRun=truevalidates current production state; it is not a sandbox.- Pagination is not documented as a snapshot.
X-Request-IDdoes not deduplicate writes.- A successful dry run does not reserve state.
- A resource may appear not found when it is outside the API-key scope.
- Download metadata can exist while
fileNameisnull, meaning no file was produced. - Order and incident lifecycle states include server-managed transitions outside the exposed mutation operation.
