BusinessTimeSlots
Search BusinessTimeSlots
Search and list BusinessTimeSlot records with filtering, sorting, and pagination.
GET
Search BusinessTimeSlots
A BusinessTimeSlot defines the days and times during which a location is open. Each time slot specifies a day of the week and a from/to time window.
The year, month, and day components of
FromTime and ToTime are always 1976-01-01 — only the time-of-day portion is meaningful.
When no time slots are defined for a location, the location is considered open at all times. Adding time slots restricts opening hours to the specified windows only.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the BusinessTimeSlot-List role.Enums
DayOfWeek — DayOfWeek values
DayOfWeek — DayOfWeek values
| Value | Name |
|---|---|
| 0 | Sunday |
| 1 | Monday |
| 2 | Tuesday |
| 3 | Wednesday |
| 4 | Thursday |
| 5 | Friday |
| 6 | Saturday |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the business linked to this record.
Filter by start time of the opening window. Only the time-of-day component is used; the date component is always 1976-01-01..
Filter by end time of the opening window. Only the time-of-day component is used; the date component is always 1976-01-01..
Filter by the day of week value for this business time slot.
Range Filters
Filter by start time of the opening window. Only the time-of-day component is used; the date component is always 1976-01-01. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by start time of the opening window. Only the time-of-day component is used; the date component is always 1976-01-01. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by end time of the opening window. Only the time-of-day component is used; the date component is always 1976-01-01. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by end time of the opening window. Only the time-of-day component is used; the date component is always 1976-01-01. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
The list of BusinessTimeSlot records matching the query. See the Get one BusinessTimeSlot endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search BusinessTimeSlots