Skip to main content
GET
List Events

List Events

Returns a paginated list of published calendar events for the current location. Supports filtering by past/upcoming, category, keyword search, and featured flag. Used to power the public-facing events catalogue and homepage event grids.
An event is a scheduled activity (workshop, networking session, etc.) published by the space operator. Events may have one or more ticket products with their own prices and availability windows.

Authentication

No authentication required. The response is scoped to the current business location.

Query Parameters

boolean
required
true — return events whose end date is in the past. false — return upcoming and active events.
number
1-based page number. Default: 1
number
Number of events per page. Default: 25
number
Filter to events belonging to a specific category. Omit to return events across all categories.
Keyword filter applied to event name and description. URL-encoded.
When true, returns only events marked as featured by the operator.
boolean
When true, returns only events that the operator has flagged to appear on the home page. Used by the upcomingEvents shortcut endpoint.
string
Comma-separated dot-notated field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Example: _shape=CalendarEvents.Records.Id,CalendarEvents.Records.Name

Response

Returns an EventList object containing pagination metadata and the paginated event records.

Core Fields

boolean
required
Mirrors the pastEvents query parameter, confirming which slice of events was returned.
EventCategory[]
All available event categories for the current location — useful for building a category filter UI without a separate request.
EventCategory | null
The currently active category filter, if categoryId was supplied.
ApiListResult<CalendarEvent>
Paginated wrapper containing the matching events. See API Overview for pagination fields (CurrentPage, TotalItems, etc.).

CalendarEvent Fields

number
required
Unique integer identifier for the event. Use this as {id} in detail, product, and waiting-list endpoints.
string
UUID for the event — stable across edits and suitable as a cache key.
string
required
Display name of the event.
string
Brief summary shown in list cards.
string
Full event description. May contain HTML.
string | null
Full name of the event host.
string | null
Venue name or room identifier.
string | null
Full postal address of the event venue.
string | null
External event URL (e.g., a Zoom or Eventbrite link).
string | null
Facebook event page URL.

Dates

string
Event start datetime in the location’s local timezone (ISO 8601).
string
Event end datetime in the location’s local timezone (ISO 8601).
string
Event start datetime in UTC (ISO 8601).
string
Event end datetime in UTC (ISO 8601).
boolean
When true, the event spans more than one calendar day.
string
Local datetime from which the event becomes visible to customers.
string
UTC equivalent of PublishDate.

Tickets & Pricing

boolean
When true, the event has at least one purchasable ticket product.
boolean
When true, all ticket products are sold out or past their sale window.
number
Lowest ticket price across all ticket products. Note the typo in the field name (Chepeast) — it is preserved as-is in the API.
number
Highest ticket price across all ticket products.
EventProduct | null
Full EventProduct object for the cheapest ticket option.
EventProduct | null
Full EventProduct object for the most expensive ticket option.
EventProduct[]
All ticket products for this event.
string | null
External URL for purchasing tickets when HasCustomTicketsPage is true.
boolean
When true, ticket purchase is handled on an external page (TicketsPage) rather than the portal checkout.
number | null
Total number of available spots. null means unlimited.
number | null
Number of tickets sold so far.
boolean
When true, customers can join a waiting list when the event is sold out.
string | null
Additional notes displayed to customers during ticket purchase.
boolean
When true, the checkout form collects the buyer’s postal address.

Categorisation & Display

EventCategory[]
Categories this event belongs to.
boolean
When true, the event appears on the portal home page.
boolean
When true, the event is promoted in the home page banner carousel.
boolean
When true, authenticated customers can post and view comments on the event detail page.

Media & Resource

boolean
When true, a small thumbnail image is available.
boolean
When true, a full-size banner image is available.
boolean
Convenience flag — true when either Location or VenueAddress is set.
Resource | null
The bookable resource associated with this event, if the event is tied to a room or desk.
boolean
When true, a resource is linked to this event (Resource is non-null).
Business
The coworking location that published the event.
{ Id: number; UpdatedOn: string }[] | null
Lightweight list of up to 10 recent attendees, used for social proof display.
EventComment[]
Published comments on the event.

Timestamps

All datetime fields are ISO 8601 strings. *On fields are in the location’s local timezone; *OnUtc fields are UTC.
string
Local datetime the event record was created.
string
UTC datetime the event record was created.
string
Local datetime of the last update.
string
UTC datetime of the last update.

Examples

Fetch upcoming events (full payload)

Fetch events with a minimal field set

Use _shape to return only the data your UI needs, reducing payload size.

TypeScript Integration

Usage in Portal

Error Responses

error
A query parameter value is invalid — for example, a non-boolean pastEvents or a negative page.