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 Integrations API

The Integrations API from Sage HR — 12 operation(s) for integrations.

Sage HR Integrations 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 Integration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 12 operations across 12 paths, and defines 24 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.

12 operations 12 paths 24 schemas 12 POST

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 Integrations 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 12

Across 12 paths, the API surfaces 12 operations — 12 POST. Each is listed below with its method, path, parameters, and response codes.

Integrations 12
POST
/vikarina/job-positions
Job position transfer from Sage HR to Vikarina
Integrations_transferJobPositionFromSageToVikarina → 200
POST
/vikarina/organization-structure
Organizational structure transfer from Sage HR to Vikarina
Integrations_transferOrganizationalStructureFromSageToVikarina → 200
POST
/vikarina/newstarter-employees
New starters list from Sage HR to Vikarina
Integrations_importNewStartersList 2 params → 200
POST
/vikarina/contract-information
Contract (custom field) information transfer from Sage HR to Vikarina
Integrations_transferContractInformationToVikarina → 200
POST
/vikarina/appointments
New appointment (position changes) information transfer from Sage HR to Vikarina
Integrations_transferAppointmentInfo 2 params → 200
POST
/vikarina/salaries
Salary information transfer from Sage HR to Vikarina to Vikarina
Integrations_transferSalaryInformation 2 params → 200
POST
/vikarina/bank-accounts
Bank account information transfer (Custom field) from Sage HR to Vikarina
Integrations_transferBankAccountInfo → 200
POST
/vikarina/terminated-employees
Termination information transfer from Sage HR to Vikarina
Integrations_transferTerminationInfoToVikarina 2 params → 200
POST
/vikarina/unused-days
Unused vacation days transfer from Sage HR to Vikarina
Integrations_transferUnusedVacationDaysToVikarina → 200
POST
/vikarina/leave-types
Leaves information transfer from Sage HR to Vikarina
Integrations_transferLeaveInformationToVikarina 2 params → 200
POST
/vikarina/timesheets
Time Schedule information transfer from Sage HR to Vikarina
Integrations_transferTimeScheduleInformation 2 params → 200
POST
/vikarina/bonuses
Sending bonuses [payed once] to Vikarina
Integrations_sendBonusesToVikarina 2 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are IntegrationsImportNewStartersListResponse_data (14 properties), IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse_data (12 properties), IntegrationsTransferAppointmentInfoResponse_data (11 properties), IntegrationsTransferTimeScheduleInformationResponse_data (9 properties). Each schema is shown below with its type and property counts.

IntegrationsTransferJobPositionFromSageToVikarinaResponse_data
object
3 properties
IntegrationsTransferAppointmentInfoResponse_data
object
11 properties
IntegrationsSendBonusesToVikarinaResponse_data
object
8 properties
IntegrationsTransferUnusedVacationDaysToVikarinaResponse
object
1 property
IntegrationsImportNewStartersListResponse
object
1 property
IntegrationsTransferBankAccountInfoResponse_data
object
6 properties
IntegrationsTransferBankAccountInfoResponse
object
1 property
IntegrationsTransferLeaveInformationToVikarinaResponse
object
1 property
IntegrationsTransferContractInformationToVikarinaResponse_data
object
8 properties
IntegrationsTransferUnusedVacationDaysToVikarinaResponse_data
object
5 properties
IntegrationsImportNewStartersListResponse_data
object
14 properties
IntegrationsTransferTimeScheduleInformationResponse_data
object
9 properties
IntegrationsTransferTerminationInfoToVikarinaResponse_data
object
9 properties
IntegrationsTransferContractInformationToVikarinaResponse
object
1 property
IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse_data
object
12 properties
IntegrationsTransferTimeScheduleInformationResponse
object
1 property
IntegrationsTransferJobPositionFromSageToVikarinaResponse
object
1 property
IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse
object
1 property
IntegrationsTransferSalaryInformationResponse
object
1 property
IntegrationsTransferSalaryInformationResponse_data
object
8 properties
IntegrationsSendBonusesToVikarinaResponse
object
1 property
IntegrationsTransferLeaveInformationToVikarinaResponse_data
object
7 properties
IntegrationsTransferAppointmentInfoResponse
object
1 property
IntegrationsTransferTerminationInfoToVikarinaResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Sage HR publishes across the network.

Sage HR Documents API
Sage HR Employee 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 Integrations 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.