List All Calendar Events

Get the calendar events of every location your company can see, across locations. Each object is one time for one location on one day of the week.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use the query parameters described below to filter the results as needed.

All filters are combined with AND, so an event must match every filter you provide. For example, location_id=7&day_of_week=0 returns only events for location 7 that fall on Monday.

calendar_event_type_id and calendar_event_type_keys accept a comma-separated list. Within a single list, values are combined with OR, so calendar_event_type_keys=opening_hours,closing_hours returns events of either type.

A managing company can use this endpoint to see both the events of their company and the events of all companies they manage.

Query Params
int32

Filter for events of this location ID.

string

Filter for these calendar event type IDs. Comma-separated to include multiple event type ids. (38,39)

string

Filter for events of these calendar event type key values. Comma-separated to include multiple. (opening_hours,closing_hours)

integer
0 to 6

Filter for events on this day with 0 representing Monday and 6 representing Sunday.

boolean
Defaults to false

Include the calendar event type's description in the response.

int32
Defaults to 20

Number of results to return per page. Max limit is 100.

int32
Defaults to 0

The initial index from which to return the results.

boolean
Defaults to false

Set to true to return only the meta block (including the total count) with an empty data array. Useful for counting events without fetching them.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json