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

Quinyx Employee API

The Employee API from Quinyx — 2 operation(s) for employee.

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

Tagged areas include Employee. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.quinyx.com, https://api-rc.quinyx.com.

6 operations 2 paths 23 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.eu.quinyx.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Quinyx Employee API declares 7 security schemes for authenticating requests. It supports OAuth 2.0 (employee_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (opening-hours_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (organisation_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (rest-api-uaa_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule-availability_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (statistics_OAuth2ClientCredentials) using the clientCredentials flow.

  • employee_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • opening-hours_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • organisation_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • rest-api-uaa_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule-availability_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • statistics_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication

Paths & Operations 6

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

Employee 6
GET
/hr/v3/employees/{id}
Get an employee
getEmployee 1 param → 200400401403404500
PUT
/hr/v3/employees/{id}
Update an employee
updateEmployee 1 param body → 200400401403404500
DELETE
/hr/v3/employees/{id}
Delete an employee
deleteEmployee 1 param → 200401403404500
PATCH
/hr/v3/employees/{id}
Partially update an employee
patchEmployee 1 param body → 200400401403404500
GET
/hr/v3/employees
List employees
getEmployees 3 params → 200400401403500
POST
/hr/v3/employees
Create an employee
createEmployee body → 201400401403500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are employee_IntegrationEmployeeResponse (11 properties), employee_CreateEmployment (9 properties), employee_Employment (9 properties), employee_UpdateEmployment (9 properties). Each schema is shown below with its type and property counts.

employee_UpdateEmergencyContact
object
4 properties 4 required
employee_CursorPaginationInfo
object
Pagination information for cursor-based pagination.
2 properties
employee_IntegrationEmployeeCreateRequest
object
8 properties 4 required
employee_Address
object
5 properties
employee_Employment
object
9 properties
employee_CreateEmployment
object
9 properties 2 required
employee_ValidationErrorDetail
object
A single validation error.
2 properties
employee_UpdateContactInformation
object
2 properties 2 required
employee_UpdatePersonalInformation
object
6 properties 6 required
employee_ValidationError
object
Validation errors, conforming to RFC 9457.
5 properties 4 required
employee_EmergencyContact
object
4 properties
employee_CursorPageIntegrationEmployeeResponse
object
A page of data along with pagination information for cursor-based pagination.
2 properties
employee_UpdatePunchSettings
object
1 property 1 required
employee_CreatePersonalInformation
object
6 properties 2 required
employee_PersonalInformation
object
6 properties
employee_PunchSettings
object
1 property
employee_UpdateEmployment
object
9 properties 6 required
employee_UpdateAddress
object
5 properties 5 required
employee_IntegrationEmployeeUpdateRequest
object
8 properties 8 required
employee_ContactInformation
object
2 properties
employee_IntegrationEmployeePatchRequest
object
8 properties
employee_IntegrationEmployeeResponse
object
11 properties
employee_ProblemDetail
object
RFC 9457 Problem Details for HTTP APIs
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-employee-api-openapi.yml Raw ↑

Other APIs Quinyx publishes across the network.

Quinyx Absence Schedules API
Quinyx Absence Types API
Quinyx Absences API
Quinyx Access Token API
Quinyx Agreements API
Quinyx AI Scheduled Headcount API
Quinyx Authentication API
Quinyx Collaboration Groups API
Quinyx Collaboration Groups Labels API
Quinyx Employees API
Quinyx Forecast Data API
Quinyx Forecast Dynamic Rules API