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

The Recruitment API from Sage HR — 5 operation(s) for recruitment.

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

This API exposes 6 operations across 5 paths, and defines 25 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.

6 operations 5 paths 25 schemas 5 GET1 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 Recruitment 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 6

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

Recruitment 6
GET
/recruitment/positions
List recruitment positions
Recruitment_listPositions 6 params → 200
GET
/recruitment/positions/{id}
Position details
Recruitment_getPositionDetails 1 param → 200
GET
/recruitment/positions/{id}/applicants
List applicants
Recruitment_listApplicants 4 params → 200
POST
/recruitment/positions/{id}/applicants
Create new applicant
Recruitment_createApplicantWithReferral 1 param body → 201422
GET
/recruitment/applicants/{id}
Applicant details
Recruitment_getApplicantDetails 1 param → 200
GET
/recruitment/applicants/{id}/actions
Applicant actions
Recruitment_listApplicantActions 3 params → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are RecruitmentGetPositionDetailsResponse_data (20 properties), RecruitmentListPositionsResponse_data_inner (18 properties), RecruitmentGetApplicantDetailsResponse_data (16 properties), RecruitmentListApplicantsResponse_data_inner (13 properties). Each schema is shown below with its type and property counts.

RecruitmentListPositionsResponse_data_inner
object
18 properties
RecruitmentGetPositionDetailsResponse_data_hiring_team_inner
object
3 properties
RecruitmentGetApplicantDetailsResponse_data_referrer
object
4 properties
RecruitmentListApplicantsResponse
object
2 properties
RecruitmentCreateApplicantWithReferralResponse_data
object
1 property
RecruitmentListApplicantsResponse_data_inner_stage
object
3 properties
RecruitmentGetPositionDetailsResponse
object
1 property
RecruitmentListPositionsResponse
object
2 properties
RecruitmentListPositionsResponse_data_inner_description_blocks_inner
object
2 properties
RecruitmentGetApplicantDetailsResponse_data_added_by
object
3 properties
RecruitmentGetPositionDetailsResponse_data
object
20 properties
RecruitmentGetPositionDetailsResponse_data_applicants_inner
object
3 properties
RecruitmentListApplicantActionsResponse_meta
object
6 properties
RecruitmentListPositionsResponse_meta
object
6 properties
RecruitmentGetApplicantDetailsResponse
object
1 property
RecruitmentListApplicantActionsResponse_data_inner
object
3 properties
RecruitmentListApplicantActionsResponse
object
2 properties
RecruitmentCreateApplicantWithReferral422Response
object
2 properties
RecruitmentGetApplicantDetailsResponse_data
object
16 properties
RecruitmentGetApplicantDetailsResponse_data_stage
object
3 properties
RecruitmentListApplicantsResponse_meta
object
6 properties
RecruitmentGetPositionDetailsResponse_data_description_blocks_inner
object
2 properties
RecruitmentCreateApplicantWithReferralResponse
object
1 property
RecruitmentListApplicantsResponse_data_inner
object
13 properties
RecruitmentCreateApplicantWithReferralRequest
object
10 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Sage HR publishes across the network.

Sage HR Documents API
Sage HR Employee 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 Teams API
Sage HR Terminations reasons API
Where this information came from

This is an independent, third-party profile of Sage HR Recruitment 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.