API reference

Generated 2026-09-27. 188 routes.

/api/attendance

MethodPath
GET/api/attendance/correction-requests
POST/api/attendance/correction-requests/:id/approve
POST/api/attendance/correction-requests/:id/decline
GET/api/attendance/dashboard
GET/api/attendance/entries
POST/api/attendance/entries
GET/api/attendance/entries/:id
PATCH/api/attendance/entries/:id
POST/api/attendance/entries/:id/recalculate
GET/api/attendance/exceptions
POST/api/attendance/jobs/freeze
POST/api/attendance/jobs/retention
GET/api/attendance/photos/:id
POST/api/attendance/punches/:id/resolve
GET/api/attendance/rules
POST/api/attendance/rules

/api/audit

MethodPath
GET/api/audit
GET/api/audit/export.csv

/api/auth

MethodPath
POST/api/auth/login
POST/api/auth/logout

/api/billing

MethodPath
GET/api/billing
POST/api/billing/cancel
POST/api/billing/change-plan
GET/api/billing/export
GET/api/billing/invoices.csv
GET/api/billing/invoices/:id
POST/api/billing/preview
POST/api/billing/resume
POST/api/billing/webhook

/api/coverage

MethodPath
GET/api/coverage
POST/api/coverage
DELETE/api/coverage/:id
PUT/api/coverage/:id
GET/api/coverage/today

/api/departments

MethodPath
GET/api/departments
POST/api/departments
PUT/api/departments/:id

/api/devices

MethodPath
GET/api/devices
POST/api/devices
GET/api/devices/:id
PUT/api/devices/:id
POST/api/devices/:id/activation-code
POST/api/devices/:id/deactivate
POST/api/devices/:id/replace

/api/employees

MethodPath
GET/api/employees
POST/api/employees
GET/api/employees/:id
PUT/api/employees/:id
POST/api/employees/:id/archive
GET/api/employees/:id/availability
PUT/api/employees/:id/availability
POST/api/employees/:id/availability/exceptions
DELETE/api/employees/:id/availability/exceptions/:eid
GET/api/employees/:id/history
POST/api/employees/:id/login
POST/api/employees/:id/pin
GET/api/employees/:id/rates
POST/api/employees/:id/rates
POST/api/employees/:id/reactivate
POST/api/employees/import
POST/api/employees/import/commit
GET/api/employees/import/template

/api/kiosk

MethodPath
POST/api/kiosk/activate
GET/api/kiosk/bootstrap
POST/api/kiosk/heartbeat
POST/api/kiosk/photos/:event_id
POST/api/kiosk/punches
GET/api/kiosk/status
POST/api/kiosk/verify-pin

/api/leave

MethodPath
GET/api/leave/counts
GET/api/leave/requests
GET/api/leave/requests/:id
POST/api/leave/requests/:id/approve
POST/api/leave/requests/:id/decline
GET/api/leave/types
POST/api/leave/types
PUT/api/leave/types/:id

/api/locations

MethodPath
GET/api/locations
POST/api/locations
PUT/api/locations/:id

/api/lookups

MethodPath
GET/api/lookups

/api/me

MethodPath
GET/api/me
GET/api/me/availability
PUT/api/me/availability
POST/api/me/availability/exceptions
DELETE/api/me/availability/exceptions/:id
GET/api/me/badges
GET/api/me/correction-requests
POST/api/me/correction-requests
GET/api/me/hours
GET/api/me/leave
POST/api/me/leave
POST/api/me/leave/:id/cancel
GET/api/me/notices
POST/api/me/notices/:id/ack
GET/api/me/notifications
POST/api/me/notifications/:id/read
POST/api/me/notifications/read-all
GET/api/me/shifts
GET/api/me/tasks
POST/api/me/tasks/:id/block
POST/api/me/tasks/:id/items/:itemId/toggle
POST/api/me/tasks/:id/start
POST/api/me/tasks/:id/submit
GET/api/me/today

/api/meta

MethodPath
GET/api/meta

/api/notices

MethodPath
GET/api/notices
POST/api/notices
GET/api/notices/:id
PUT/api/notices/:id
GET/api/notices/:id/acks
POST/api/notices/:id/publish
POST/api/notices/:id/remind

/api/notifications

MethodPath
GET/api/notifications/log

/api/onboarding

MethodPath
GET/api/onboarding
PUT/api/onboarding
POST/api/onboarding/complete
POST/api/onboarding/reopen

/api/org

MethodPath
GET/api/org/roles

/api/platform

MethodPath
GET/api/platform/audit
GET/api/platform/health
GET/api/platform/retention
GET/api/platform/support-grants
POST/api/platform/support-grants
DELETE/api/platform/support-grants/:id
GET/api/platform/tenants
GET/api/platform/tenants/:id
GET/api/platform/tenants/:id/retention
PUT/api/platform/tenants/:id/retention
PUT/api/platform/tenants/:id/status

/api/positions

MethodPath
GET/api/positions
POST/api/positions
PUT/api/positions/:id

/api/pricing

MethodPath
GET/api/pricing

/api/sandbox

MethodPath
GET/api/sandbox/checkout/:id
POST/api/sandbox/checkout/:id/complete
POST/api/sandbox/checkout/:id/decline
POST/api/sandbox/simulate

/api/schedules

MethodPath
GET/api/schedules
POST/api/schedules
GET/api/schedules/:id
POST/api/schedules/:id/apply-template
POST/api/schedules/:id/check
GET/api/schedules/:id/compare
POST/api/schedules/:id/copy-previous
POST/api/schedules/:id/discard
GET/api/schedules/:id/eligibility
POST/api/schedules/:id/generate
GET/api/schedules/:id/publications
POST/api/schedules/:id/publish
POST/api/schedules/:id/rollback
POST/api/schedules/:id/save-template
POST/api/schedules/:id/shifts
DELETE/api/schedules/:id/shifts/:shiftId
PUT/api/schedules/:id/shifts/:shiftId
POST/api/schedules/:id/shifts/:shiftId/lock
POST/api/schedules/:id/validate
GET/api/schedules/week

/api/scheduling

MethodPath
GET/api/scheduling/config
PUT/api/scheduling/config
GET/api/scheduling/employees
PUT/api/scheduling/employees/:id/targets
GET/api/scheduling/templates
DELETE/api/scheduling/templates/:id

/api/signup

MethodPath
POST/api/signup

/api/simulation

MethodPath
POST/api/simulation/reset

/api/tasks

MethodPath
GET/api/tasks
POST/api/tasks
GET/api/tasks/:id
PUT/api/tasks/:id
POST/api/tasks/:id/return
POST/api/tasks/:id/verify
GET/api/tasks/photos/:id

/api/tenant

MethodPath
GET/api/tenant
PUT/api/tenant/employee-portal
GET/api/tenant/organisation
PUT/api/tenant/organisation
GET/api/tenant/retention
GET/api/tenant/settings
PUT/api/tenant/settings

/api/timesheets

MethodPath
GET/api/timesheets/cycles
GET/api/timesheets/cycles/:index
POST/api/timesheets/cycles/:index/close
GET/api/timesheets/cycles/:index/export.csv
POST/api/timesheets/cycles/:index/reopen

/api/wages

MethodPath
PUT/api/wages/budget
GET/api/wages/estimate

/api/work

MethodPath
GET/api/work/summary