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.

This API call searches tags by name.

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.
  • name*: The name of the tag.
  • page: The page size.
  • size: The size of the page.
Body

This API call has no-body.

Response
  • categories: List of tag categories.
    • 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.
  • tags: List of tags.
    • name: The name of the tag.
    • id: The ID of the tag.
    • tagCategoryId: The ID of the tag category the tag is associated with.
  • pagination: List of current page information related to the tag.
    • totalCount: The total amount of tags.
    • currentPage: The current page where the tag can be found.
    • totalPages: The total amount of pages of tags within the Quinyx GUI.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/tags/external/groups/123/tag-info/search?name=temp&page=1&size=20
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/groups/123/tag-info/search?name=temp&page=1&size=20
Response
{   
"result": {       
"categories": {           
"1234": {               
"id": 1234,               
"name": "exampleCategoryName",               
"tagType": "ACCOUNT",               
"color": "#ffffff"           
}       
},       
"tags": [           
{               
"name": "exampleTagName",               
"id": 987654,               
"tagCategoryId": 1234
}                
]   
},   
"pagination": {       
"totalCount": 1,       
"currentPage": 1,       
"totalPages": 1
}
}

GET/external/groups/{groupId}/tag-info/by-id

This API call retrieves tag information for the specified list of tag IDs.

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.
  • ids*: List of tag IDs from which you want to retrieve information.
  • profile: Profile type for tag information.
Body

This API call has no-body.

Response
  • categories: List of tag categories.
    • 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.
  • tags: List of tags.
    • name: The name of the tag.
    • id: The ID of the tag.
    • tagCategoryId: The ID of the tag category associated with the tag.

Example

Endpoint
For the production environment: https://api.quinyx.com/v2/tags/external/groups/123/tag-info/by-id?ids=123&ids=123&profile=FULL
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/groups/123/tag-info/by-id?ids=123&ids=123&profile=FULL
Response
{   
"categories": {       
"123": {           
"id": 123,           
"name": "exampleCategoryName",           
"tagType": "ACCOUNT",           
"color": "#ffffff"       
}   
},   
"tags": [       
{           
"name": "exampleTagName",           
"id": 98765,           
"tagCategoryId": 123       
}   
]
}

How Did We Do?