GET Data
Updated
by
Victor Jespersen
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “tags” definition)
Api-docs: https://api.quinyx.com/v2/docs (select “tags” 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/external/accounts/{groupId}/categories/{categoryId}
This API call will retrieve information regarding a specific tag category by ID.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The ID of the Quinyx group from which you want to fetch the tag information.
- categoryId*: The ID of the tag category from which you want to retrieve information.
Body
This API call has no-body.
Response
- id: The ID of the tag category.
- name: The name of the tag category
- tagType: The tag category type.
- color: The color of the tag category.
- externalId: The external ID of the tag category set in Quinyx GUI.
Example
Endpoint
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/accounts/123/categories/321
Response
"id": 321,
"name": "exampleCategoryName",
"tagType": "ACCOUNT",
"color": "#ffffff",
"externalId": "exampleId"
}
GET/external/accounts/{groupId}/categories
This API call will retrieve information for all existing tag categories.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The ID of the Quinyx group from which you want to fetch the tag category information.
Body
This API call has no-body.
Response
- id: The ID of the tag category.
- name: The name of the category.
- tagType: The tag category type.
- color: The color of the tag category.
- externalId: The external ID of the tag category set within the Quinyx GUI.
Example
Endpoint
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/accounts/123/categories
Response
{
"id": 2216,
"name": "test",
"tagType": "ACCOUNT",
"color": "#ffffff",
"externalId": "test"
}
]
