HR Partner Addresses API
List employee address records.
HR Partner Addresses 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 Addresses. 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 1 operation across 1 path, and defines 2 schemas. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HR Partner Addresses 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 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
List employee address records.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Address (9 properties), EmployeeRef (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HR Partner 12
Other APIs HR Partner publishes across the network.