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/{groupId}/opening-hours
This API call fetches all opening hours set up in your Quinyx environment.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The groupID of the unit you want to fetch the opening hours data.
Body
This API call has no-body.
Response
- id: The opening hours ID of your opening hour.
- groupId: The associated group ID with your opening hour.
- name: The name of your opening hour.
- startDate: The start date of your opening hour.
- type: Whether the opening hour is a STANDARD or SPECIAL type.
- weekdayHours: A list of all weekdays and the details of the specified dates.
- id: The ID of the specific weekday.
- openingHoursId: The opening hours ID of your opening hour.
- weekday: Gives an integer depending on which date it is. (0 = Monday, 1= Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday).
- startTime: The start time of the weekday.
- endTime: The end time of the weekday.
- open: Whether the date is open for business or not.
Example
Endpoint
For the RC environment: https://api-rc.quinyx.com/v2/opening-hours/groups/123/opening-hours
Response
[
{
"id": "2b2b126d-a68f-48ef-a25a-5b6cb36c1eb1",
"groupId": 123,
"name": "test",
"startDate": "2023-11-01",
"type": "STANDARD",
"weekdayHours": [
{"id": "0db02af6-cc2b-4ab0-a190-738c720ad1ac",
"openingHoursId": "2b2b126d-a68f-48ef-a25a-5b6cb36c1eb1",
"weekday": 1,
"startTime": "09:00:00",
"endTime": "14:00:00",
"open": true }]
}
]GET/groups/{groupId}/open-periods
This API call fetches all the opening periods for your weekdays during a selected period.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The group ID for your Quinyx account.
- periodStart*: The start date for which the period you want to fetch the opening hours.
- periodEnd*: The end date for which the period you want to fetch the opening hours.
Body
This API call has no-body.
Response
- open: Fetches the start date and time.
- close: Fetches the end date and time.
Example
Endpoint
For the RC environment: https://api-rc.quinyx.com/v2/opening-hours/groups/241242/open-periods?periodStart=2024-10-30&periodEnd=2024-12-01
Response
[
{
"open": "2024-10-30T08:00:00",
"close": "2024-10-30T17:00:00"
}
]