List events
list_eventsRead-onlyIdempotent
Retrieve Bookwhen classes, courses, and workshops with dates, attendee limits, tags, and locations. Filter by title, tag, calendar, or date range to find scheduled events.
Instructions
List events (classes, courses, workshops) with date, attendee limit and count, tags and location ID. The API returns events from today onwards unless from is given; every filter is combined with AND, and multiple values within one filter are sent comma-separated. Pages are followed until the API reports no next page or max_results is reached.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Non-inclusive end, YYYYMMDD or YYYYMMDDHHMMSS (filter[to]) | |
| from | No | Inclusive start, YYYYMMDD or YYYYMMDDHHMMSS (filter[from]; the API defaults to today) | |
| tags | No | Tag words to include (filter[tag]) | |
| title | No | Entry titles to search for (filter[title]) | |
| detail | No | Entry details text to search for (filter[detail]) | |
| compact | No | Combine the events of a course into a single virtual event (filter[compact]) | |
| calendar | No | Calendars (schedule pages) to restrict to (filter[calendar]) | |
| location | No | Location slugs to include (filter[location]) | |
| max_results | No | Maximum number of events to return | |
| include_location | No | Side-load each event's location (include=location). Slower; the API recommends includes for single-event requests | |
| include_contact_details | No | Stop redacting email addresses and phone numbers from titles, details and location text |