Skip to content
Log in Request a demo

v1.2.0

Public methods for managing employee records and all historical entities are now available.

Core operations:

  • POST /api/v1/employees - create an employee (no email required; include hire date and optional position/compensation)
  • GET /api/v1/employees/{id} - get full employee profile
  • PUT /api/v1/employees/{id} - update personal data and custom fields (custom_fields: {slug: value})
  • DELETE /api/v1/employees/{id} - archive (soft-delete) an employee

Position history (department / division / position / manager / legal_entity / location):

  • POST /api/v1/employees/{id}/positions - add
  • PUT /api/v1/employees/{id}/positions/{id} - update
  • DELETE /api/v1/employees/{id}/positions/{id} - delete
  • POST /api/v1/employees/{id}/positions/search - paginated search

Employment history (contract type, employment type, work pattern, probation):

  • POST /api/v1/employees/{id}/employments - add
  • PUT /api/v1/employees/{id}/employments/{id} - update
  • DELETE /api/v1/employees/{id}/employments/{id} - delete
  • GET /api/v1/employees/{id}/employments - get full history

Compensation history (base salary gross/net):

  • POST /api/v1/employees/{id}/compensations - add
  • PUT /api/v1/employees/{id}/compensations/{id} - update
  • DELETE /api/v1/employees/{id}/compensations/{id} - delete
  • POST /api/v1/employees/{id}/compensations/search - paginated search

Additional compensations (bonuses and allowances as an entity):

  • POST /api/v1/employees/{id}/additional-compensations - create
  • PUT /api/v1/employees/{id}/additional-compensations/{id} - update
  • DELETE /api/v1/employees/{id}/additional-compensations/{id} - delete
  • GET /api/v1/employees/{id}/additional-compensations - list

Custom table rows (bonuses, payment details, etc.):

  • POST /api/v1/employees/{id}/field-tables/{table_id}/rows - add a row
  • PUT /api/v1/employees/{id}/field-tables/{table_id}/rows/{id} - update
  • DELETE /api/v1/employees/{id}/field-tables/{table_id}/rows/{id} - delete

  • GET /api/v1/custom-fields/tables - list all custom tables with field definitions (slug, type, select options)
  • POST /api/v1/custom-fields/tables/{table_id}/rows/search - search rows with filters by employees, date range, lifecycle statuses, field values, and pagination

  • GET /api/v1/time-off/categories - list all time-off categories for the organization
  • POST /api/v1/time-off/logs/search - employee leave history (accruals, usages, expirations, adjustments) with filters by categories, action types, and request statuses
  • POST /api/v1/time-off/employee/balance - employee time-off balance across all categories as of a specific date

New guide sections added: