API reference
Every endpoint with its parameters, request body, response fields and example response. The page is generated from the OpenAPI document at build time.
Developer documentation
Machine-readable document: /api/v1/openapi.json
Key
- GET
/api/v1/keyName, scopes and expiry of the key in use
Employees
- GET
/api/v1/employeesLists employees - POST
/api/v1/employeesCreates an employee - GET
/api/v1/employees/{id}Returns one employee - PATCH
/api/v1/employees/{id}Updates the allowed fields of an employee
Company structure
- GET
/api/v1/companiesLists companies - GET
/api/v1/companies/{id}Returns one company - GET
/api/v1/job-titlesLists job titles - GET
/api/v1/job-titles/{id}Returns one job title - GET
/api/v1/locationsLists locations - GET
/api/v1/locations/{id}Returns one location - GET
/api/v1/org-unitsLists organisation units - GET
/api/v1/org-units/{id}Returns one organisation unit
Leave
- GET
/api/v1/leave-balancesLists leave balances - GET
/api/v1/leave-requestsLists leave requests - GET
/api/v1/leave-requests/{id}Returns one leave request - GET
/api/v1/leave-typesLists leave types - GET
/api/v1/leave-types/{id}Returns one leave type
Shifts
- GET
/api/v1/shift-assignmentsLists shift assignments - GET
/api/v1/shift-assignments/{id}Returns one shift assignment
Events
- GET
/api/v1/eventsReads the event feed
Health
- GET
/api/v1/health/duty-rosterReturns the duty roster (who works which duty or working time on which day) - GET
/api/v1/health/physician-availabilityReturns physician availability using FHIR Slot statuses - POST
/api/v1/health/physician-premiumsWrites physician performance premiums