How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sage HR Employee API

The Employee API from Sage HR — 9 operation(s) for employee.

Sage HR Employee API is one of 14 APIs that Sage HR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Employee. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 11 operations across 9 paths, and defines 36 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://subdomain.sage.hr/api.

11 operations 9 paths 36 schemas 7 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Server
https://subdomain.sage.hr/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Sage HR Employee API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (api_key).

  • api_key — All request are required to pass a X-Auth-Token header.

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 7 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Employee 11
GET
/employees
List active employees in company
Employee_listActiveEmployees 4 params → 200
POST
/employees
Create new employee
Employee_createNewEmployee body → 201
GET
/employees/{id}
Single active employee in company
Employee_getById 4 params → 200
PUT
/employees/{id}
Update Employee
Employee_updateById 1 param body → 202404
GET
/employees/{id}/custom-fields
Employee custom fields
Employee_getCustomFields 1 param → 200
PUT
/employees/{id}/custom-fields/{custom_field_id}
Update custom field
Employee_updateCustomField 2 params body → 200422
POST
/employees/{id}/terminations
Terminate employee
Employee_terminateEmployee 1 param body → 201
GET
/terminated-employees
List terminated employees in company
Employee_listTerminatedEmployees 1 param → 200
GET
/terminated-employees/{id}
Single terminated employee in company
Employee_getTerminatedEmployee 1 param → 200
GET
/employees/{id}/leave-management/balances
Employee time off balances
LeaveManagement_getTimeOffBalances 1 param → 200
GET
/employees/{id}/compensations
Employee compensations
Employee_getCompensations 1 param → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are EmployeeGetByIdResponse_data (26 properties), EmployeeListActiveEmployeesResponse_data_inner (26 properties), EmployeeGetTerminatedEmployeeResponse_data (10 properties), EmployeeUpdateByIdRequest (10 properties). Each schema is shown below with its type and property counts.

EmployeeGetByIdResponse_data
object
26 properties
EmployeeGetTerminatedEmployeeResponse_data_termination
object
2 properties
EmployeeListActiveEmployeesResponse_data_inner_position_history_inner
object
5 properties
EmployeeTerminateEmployeeResponse
object
1 property
EmployeeUpdateByIdRequest
object
10 properties
EmployeeUpdateById404Response
object
2 properties
EmployeeTerminateEmployeeRequest
object
3 properties 2 required
EmployeeGetCustomFieldsResponse_data_inner
object
5 properties
EmployeeGetCompensationsResponse_data_inner
object
7 properties
EmployeeGetCustomFieldsResponse
object
1 property
EmployeeGetCompensationsResponse_meta
object
6 properties
EmployeeGetByIdResponse_data_team_history_inner
object
4 properties
EmployeeListActiveEmployeesResponse_meta
object
6 properties
EmployeeUpdateCustomFieldRequest
object
1 property 1 required
EmployeeUpdateByIdResponse
object
1 property
EmployeeUpdateByIdResponse_data
object
1 property
EmployeeGetTerminatedEmployeeResponse_data
object
10 properties
EmployeeGetByIdResponse_data_position_history_inner
object
5 properties
EmployeeGetTerminatedEmployeeResponse
object
1 property
EmployeeGetCompensationsResponse
object
2 properties
EmployeeCreateNewEmployeeResponse_data
object
1 property
EmployeeListActiveEmployeesResponse_data_inner_team_history_inner
object
4 properties
EmployeeListTerminatedEmployeesResponse_data_inner
object
10 properties
EmployeeListActiveEmployeesResponse_data_inner
object
26 properties
EmployeeCreateNewEmployeeResponse
object
1 property
LeaveManagementGetTimeOffBalancesResponse_data_inner
object
3 properties
LeaveManagementGetTimeOffBalancesResponse
object
1 property
EmployeeCreateNewEmployeeRequest
object
5 properties 3 required
EmployeeUpdateCustomField422Response
object
2 properties
EmployeeListTerminatedEmployeesResponse_meta
object
6 properties
EmployeeUpdateCustomFieldResponse
object
1 property
EmployeeListActiveEmployeesResponse
object
2 properties
EmployeeGetByIdResponse
object
1 property
EmployeeGetByIdResponse_data_employment_status_history_inner
object
4 properties
EmployeeListActiveEmployeesResponse_data_inner_employment_status_history_inner
object
4 properties
EmployeeListTerminatedEmployeesResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sage-hr-employee-api-openapi.yml Raw ↑

Other APIs Sage HR publishes across the network.

Sage HR Documents API
Sage HR Integrations API
Sage HR KIT days API
Sage HR Leave management API
Sage HR Offboarding API
Sage HR Onboarding API
Sage HR Performance API
Sage HR Policies API
Sage HR Positions API
Sage HR Recruitment API
Sage HR Teams API
Sage HR Terminations reasons API
Where this information came from

This is an independent, third-party profile of Sage HR Employee API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.