Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HR Partner Employees API

Read, create, and update employee records.

HR Partner Employees API is one of 31 APIs that HR Partner publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Employees. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.hrpartner.io.

3 operations 2 paths 1 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.hrpartner.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

HR Partner Employees API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKeyHeader). By default, every request must be authenticated.

Paths & Operations 3

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

Employees 3

Read, create, and update employee records.

GET
/employees
List Employees
listEmployees 10 params → 200
GET
/employee/{employeeCode}
Get Employee
getEmployee 1 param → 200
POST
/employee/{employeeCode}
Create Or Update Employee
upsertEmployee 1 param body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Employee (19 properties). Each schema is shown below with its type and property counts.

Employee
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hr-partner-employees-api-openapi.yml Raw ↑

Other APIs HR Partner publishes across the network.

HR Partner Absences API
HR Partner Addresses API
HR Partner Applicants API
HR Partner Application Stage Tracking API
HR Partner Applications API
HR Partner Assets API
HR Partner Attachments API
HR Partner Benefits API
HR Partner Checklists API
HR Partner Company API
HR Partner Contacts API
HR Partner Dependents API