Quinyx Collaboration Groups API

The Collaboration Groups API from Quinyx — 17 operation(s) for collaboration groups.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 19 operations across 17 paths, and defines 9 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.

19 operations 17 paths 9 schemas 3 DELETE9 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

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

Authentication & Security 7

Quinyx Collaboration Groups 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 19

Across 17 paths, the API surfaces 19 operations — 3 DELETE, 9 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Collaboration Groups 19

GET

/v2/collaboration-groups/groups/{collaborationGroupId}

Get collaboration group by id

getCollaborationGroupsById 2 params → 200

PUT

/v2/collaboration-groups/groups/{collaborationGroupId}

Update collaboration group

editCollaborationGroups 1 param body → 200

DELETE

/v2/collaboration-groups/groups/{collaborationGroupId}

Delete collaboration group with its children

deleteCollaborationGroupsWithChildren 2 params → 200

PUT

/v2/collaboration-groups/groups/{collaborationGroupId}/unarchive

Unarchive collaboration group

unArchiveCollaborationGroup 1 param → 200

PUT

/v2/collaboration-groups/groups/{collaborationGroupId}/move

Move a collaboration group to a new parent

moveCollaborationGroup 1 param body → 200

PUT

/v2/collaboration-groups/groups/{collaborationGroupId}/archive

Archive collaboration group

archiveCollaborationGroup 1 param → 200

POST

/v2/collaboration-groups/groups

Create collaboration group for domain

createCollaborationGroups body → 200

POST

/v2/collaboration-groups/associate-groups

Associate groups to a collaboration group

associateGroupsToCollaborationGroup body → 200

POST

/v2/collaboration-groups/associate-employees

Associate employees to a collaboration group

associateEmployeesToCollaborationGroup body → 200

GET

/v2/collaboration-groups/root-by-domain/{domainId}

Get root collaboration group by domain id

getRootCollaborationGroupsByDomain 1 param → 200

GET

/v2/collaboration-groups/groups/{rootGroupId}/all-under-root

List collaboration groups under root

getAllCollaborationGroupsUnderRoot 2 params → 200

GET

/v2/collaboration-groups/groups/{parentId}/children

List child collaboration groups

getChildrenGroups 1 param → 200

GET

/v2/collaboration-groups/groups/{collaborationGroupId}/employees

List employee ids in collaboration group

getCollaborationGroupEmployeeIds 2 params → 200

GET

/v2/collaboration-groups/groups/{collaborationGroupId}/eligible-parents

List eligible parent collaboration groups

getEligibleParentCollaborationGroups 1 param → 200

GET

/v2/collaboration-groups/groups/group/{groupId}

List collaboration groups for group

getCollaborationGroupsByEmployeeGroupId 1 param → 200

GET

/v2/collaboration-groups/groups/employee/{employeeId}

List collaboration groups for employee

getCollaborationGroupsByEmployeeId 1 param → 200

GET

/v2/collaboration-groups/by-root/{rootCollaborationGroupId}/employee/{employeeId}

Get collaboration group by root id and employee id

getCollaborationGroupByRootIdAndEmployeeId 2 params → 200

DELETE

/v2/collaboration-groups/delete-groups

Remove groups from a collaboration group, optionally including archived collaboration groups

deleteGroupsFromCollaborationGroup 1 param body → 200

DELETE

/v2/collaboration-groups/delete-employees

Remove employees from a collaboration group, optionally including archived collaboration groups

deleteEmployeesFromCollaborationGroup 1 param body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are collaboration-groups_CollaborationGroupDetails (9 properties), collaboration-groups_CollaborationGroup (7 properties), collaboration-groups_CollaborationGroupCreate (5 properties), collaboration-groups_CollaborationGroupUpdate (3 properties). Each schema is shown below with its type and property counts.

collaboration-groups_CollaborationGroupEmployeeDTO

object

2 properties 2 required

collaboration-groups_CollaborationGroupUpdate

object

3 properties 2 required

collaboration-groups_CollaborationGroup

object

7 properties

collaboration-groups_CollaborationGroupDetails

object

9 properties

collaboration-groups_CollaborationGroupEmployee

object

2 properties

collaboration-groups_CollaborationGroupCreate

object

5 properties 3 required

collaboration-groups_CollaborationGroupGroupDTO

object

2 properties 2 required

collaboration-groups_CollaborationGroupGroup

object

2 properties

collaboration-groups_CollaborationGroupMove

object

1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Quinyx publishes across the network.

Quinyx Absence Schedules API

AE Profile APIs.io

Quinyx Absence Types API

AE Profile APIs.io

Quinyx Absences API

AE Profile APIs.io

Quinyx Access Token API

AE Profile APIs.io

Quinyx Agreements API

AE Profile APIs.io

Quinyx AI Scheduled Headcount API

AE Profile APIs.io

Quinyx Authentication API

AE Profile APIs.io

Quinyx Collaboration Groups Labels API

AE Profile APIs.io

Quinyx Employee API

AE Profile APIs.io

Quinyx Employees API

AE Profile APIs.io

Quinyx Forecast Data API

AE Profile APIs.io

Quinyx Forecast Dynamic Rules API

AE Profile APIs.io

#Collaboration Groups

← Back to Q APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Quinyx Collaboration Groups API

Metadata

Authentication & Security 7

Paths & Operations 19

Schemas 9

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Quinyx Collaboration Groups API

Metadata

Authentication & Security 7

Paths & Operations 19

Schemas 9

Specification

Source

More from Quinyx 12

API Details

Provider

Explore more