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

The Group API from Quinyx — 2 operation(s) for group.

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

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

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

5 operations 2 paths 7 schemas 1 DELETE2 GET1 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 Group 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 5

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

Group 5
GET
/organization/v3/groups/{id}
Get a group
getGroup 1 param → 200401403404500
PUT
/organization/v3/groups/{id}
Update a group
updateGroup 1 param body → 200400401403404500
DELETE
/organization/v3/groups/{id}
Deletes a group
deleteGroup 1 param → 202401403404500
GET
/organization/v3/groups
List groups
getGroups 3 params → 200400401403500
POST
/organization/v3/groups
Create a group
createGroup body → 201400401403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are organisation_GroupResponse (9 properties), organisation_CreateGroupRequest (6 properties), organisation_ValidationError (5 properties), organisation_ProblemDetail (5 properties). Each schema is shown below with its type and property counts.

organisation_CreateGroupRequest
object
Request payload used to create a new group
6 properties 3 required
organisation_CursorPageGroupResponse
object
A page of data along with pagination information for cursor-based pagination.
2 properties
organisation_ProblemDetail
object
RFC 9457 Problem Details for HTTP APIs
5 properties 3 required
organisation_GroupResponse
object
Represents a group within the organization hierarchy
9 properties
organisation_ValidationErrorDetail
object
A single validation error.
2 properties
organisation_CursorPaginationInfo
object
Pagination information for cursor-based pagination.
2 properties
organisation_ValidationError
object
Validation errors, conforming to RFC 9457.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-group-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