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

The Role API from Quinyx — 2 operation(s) for role.

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

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

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

2 operations 2 paths 6 schemas 2 GET

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 Role 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 2

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

Role 2
GET
/organization/v3/roles
List roles
getRoles 2 params → 200400401403500
GET
/organization/v3/roles/{id}
Get a role
getRole 1 param → 200401403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are security_ValidationError (5 properties), security_ProblemDetail (5 properties), security_RoleResponse (4 properties), security_CursorPaginationInfo (2 properties). Each schema is shown below with its type and property counts.

security_ValidationErrorDetail
object
A single validation error.
2 properties
security_CursorPageRoleResponse
object
A page of data along with pagination information for cursor-based pagination.
2 properties
security_RoleResponse
object
Represents a role within the organization
4 properties
security_ProblemDetail
object
RFC 9457 Problem Details for HTTP APIs
5 properties 3 required
security_CursorPaginationInfo
object
Pagination information for cursor-based pagination.
2 properties
security_ValidationError
object
Validation errors, conforming to RFC 9457.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-role-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 Employee API
Quinyx Employees API
Quinyx Forecast Data API