GET data

Updated by Daniel Sjögren

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/labels/{labelId}

This API call will fetch the label by ID.

Field description

Mandatory fields will be marked with an asterisk*.

Endpoint
  • labelId*: The ID of the label that you want to fetch.
Body

This API call has no body.

Response
  • id: Displays the ID of the label you have fetched.
  • name: Displays the name of the label you have fetched.
  • color: Displays the assigned color of the label you have fetched.
  • domainId: Displays the Quinyx customer ID that the label you fetched belongs to.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/labels/1575
For the RC environment: https://api-rc.quinyx.com/v2/collaboration-groups/labels/1575
Responses
Example Value:
{
"id": 1575,
"name": "Headquarters",
"color": "green",
"domainId": 123
}

GET/labels/domain/{domainId}

This API call will fetch all labels for a specific domain.

Field description

Mandatory fields will be marked with an asterisk*.

Endpoint

domainId*: The ID of the domain that you wish to fetch labels for.

Body

This API call has no body.

Response
  • id: Displays the label ID.
  • name: Displays the name of the label.
  • color: Displays the color assigned to the label.
  • domainId: Displays the Quinyx customer ID that existing labels belong to.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/collaboration-groups/labels/domain/
For the RC environment: https://api.quinyx.com/v2/collaboration-groups/labels/domain/
Responses
Example value
{
"id": 1575,
"name": "District North",
"color": "blue",
"domainId": 123
}
Read more about our REST documentation here.

How Did We Do?