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/groups/{groupId}/tags/{tagId}
This API call retrieves a specific tag by 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.
- tagId*: The ID of the tag from which you want to fetch data.
Body
This API call has no-body.
Response
- name: The name of the tag.
- code: The tag code of the tag.
- externalId: The external ID of the tag.
- information: The information paragraph of the tag.
- uniqueScheduling: Boolean showing whether shifts associated with this tag can overlap.True = Shifts associated with this tag cannot overlap.
False = Shifts associated with this tag can overlap. - startDate: The start date of the tag.
- endDate: The end date of the tag.
- periods: A list of periods associated with the tag.
- coordinates: A list of coordinates associated with the tag.
- customFields: A list of custom fields associated with the tag.
- groupId: The group ID under which the tag exists.
- id: The tag ID of the tag you fetched information.
- tagCategoryId: The tag category ID of the associated tag category.
Example
Endpoint
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/groups/123/tags/321
Response
"name": "exampleTagName",
"code": "exampleTagCode",
"externalId": "exampleExternalId",
"information": "",
"uniqueScheduling": false,
"startDate": "2022-06-01",
"endDate": "2025-01-31",
"periods": [],
"coordinates": [],
"customFields": [],
"groupId": 123,
"id": 321,
"tagCategoryId": 987
}
GET/external/groups/{groupsId}/tags
This API call retrieves a list of all tags available to the specified group.
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.
- page: The page number from which the tag exists.
- size: The number of tags per page.
- name: Filter tags by name.
Body
This API call has no-body.
Response
- result: A list of tags.
- name: The name of the tag.
- code: The tag code of the tag.
- externalId: The external ID of the tag.
- information: The information paragraph of the tag.
- uniqueScheduling: Boolean showing whether shifts associated with this tag can overlap.True = Shifts associated with this tag cannot overlap.
False = Shifts associated with this tag can overlap. - startDate: The start date of the tag.
- endDate: The end date of the tag.
- periods: A list of periods associated with the tag.
- coordinates: A list of coordinates associated with the tag.
- customFields: A list of custom fields associated with the tag.
- groupId: The group ID under which the tag exists.
- id: The tag ID of the tag you fetched information.
- tagCategoryId: The tag category ID of the associated tag category.
- pagination: A list of page information.
- totalCount: The total amount of tags.
- currentPage: The current page where the tags exist.
- totalPages: The total amount of pages.
Example
Endpoint
For the RC environment: https://api-rc.quinyx.com/v2/tags/external/groups/123/tags?page=1&size=20&name=exampleTagName
Response
"result": [
{
"name": "exampleTagName",
"code": "exampleTagCode",
"externalId": "exampleExternalId",
"information": "",
"uniqueScheduling": true,
"startDate": "2022-06-01",
"endDate": "2025-01-31",
"periods": [],
"coordinates": [],
"customFields": [],
"groupId": 123,
"id": 321,
"tagCategoryId": 987
}
],
"pagination": {
"totalCount": 2,
"currentPage": 1,
"totalPages": 1
}
}
