GET data
Updated
by
Victor Jespersen
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “collaboration-groups” definition)
Api-docs: https://api.quinyx.com/v2/docs (select “collaboration-groups” definition)
Base URL can be found on links above for both environments. The remainder of this article should be considered a complement to the above Open API documentation.
GET/groups/{collaborationGroupId}
This API call fetches collaboration groups by ID.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- collaborationGroupId*: The ID of the collaboration group you want to fetch.
Body
This API call has no-body.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employee IDs associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}GET/root-by-domain/{domainId}
This API call fetches collaboration groups by domain ID.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- domainId*: The ID of the domain.
Body
This API call has no-body.
Response
- id: Displays the domain ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employee IDs associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/root-by-domain/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/root-by-domain/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/root-by-domain/123
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}GET/groups/{rootGroupId}/all-under-root
This API call fetches all collaboration groups under a given root ID.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- rootGroupId*: The ID of the root collaboration group you want to fetch the collaboration groups from.
Body
This API call has no-body.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employee IDs associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/123/all-under-root
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123/all-under-root
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123/all-under-root
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}GET/groups/{parentId}/children
This API call fetches children groups of a given collaboration group.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- parentId*: The ID of the parent collaboration group you want to fetch the child collaboration group from.
Body
This API call has no-body.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employee IDs associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/123/children
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123/children
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123/children
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}GET/groups/{collaborationGroupId}/employees
This API call fetches employee IDs associated with a collaboration group.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- collaborationGroupId*: The ID of the collaboration group ID you want to fetch.
Body
This API call has no-body.
Response
- employee ID: Displays all employee IDs associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/123/employees
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123/employees
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/123/employees
Responses
["Employee IDs"]
GET/groups/group/{groupId}
This API call fetches all collaboration groups associated with a given group.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The group ID associated with the collaboration groups you want to fetch.
Body
This API call has no-body.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employee IDs associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/group/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/group/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/group/123
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}GET/groups/employee/{employeeId}
This API call fetches all collaboration groups associated with a given employee.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- employeeId*: Employee ID of the employee you want to see which collaboration group it is associated with.
Body
This API call has no-body.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employee IDs associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/groups/employee/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/employee/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/groups/employee/123
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}GET/by-root/{rootCollaborationGroupId}/employee/{employeeId}
This API call fetches a collaboration group that an employee is assigned to, given a root ID and employee ID.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- rootCollaborationGroupId*: The ID of the root collaboration group.
- employeeID*: Employee ID of the employee you want to see which collaboration group it is associated with.
Body
This API call has no-body.
Response
- id: Displays the collaboration group ID.
- name: Displays the name of the collaboration group.
- groups: Displays the groups associated with the fetched collaboration group.
- employees: Displays the employees associated with the fetched collaboration group.
- parent: Displays the ID of the parent collaboration group associated with the fetched collaboration group.
- children: Displays the ID of the children collaboration groups associated with the fetched collaboration group.
- labelId: Displays the label ID of the label associated with the fetched collaboration group.
- domoDashboardId: Displays the Domo dashboard ID associated with the fetched collaboration group.
Example
Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/by-root/123/employee/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/by-root/123/employee/123
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/by-root/123/employee/123
Responses
{"id": 123,
"name": "string",
"groups": [0],
"employees": [0],
"parent": 0,
"children": [0],
"labelId": 0,
"domoDashboardId": "string"}