Skip to main content
GET
List Events
Returns a paginated list of events for your company, newest first. Supports Stripe-style range filters on service_start_time and created_at, equality filters on location_id and booking_id, cursor-based pagination, and inline expansion of related objects.

Pagination

List endpoints use cursor-based pagination — pass the id of the last event in the previous page as starting_after:
The response includes a hasMore flag indicating whether further pages exist.

Date-range filters

service_start_time and created_at accept Stripe-style bracket-notation operators (gt, gte, lt, lte). Values must be full ISO 8601 datetimes with a timezone designator (Z or ±HH:MM):
Bare dates like 2026-06-01 are rejected — include the time and offset. Multiple operators on the same field combine as a range. expand[] accepts the same allow-list as the single-event endpoint, with one difference: every path must be prefixed with data. because the objects you’re expanding live inside the envelope’s data array.
Limits: 20 paths max per request, depth 4 max (counted after stripping the data. prefix). Unknown, malformed, or un-prefixed paths return 400.

Sort order

Results are always returned sorted by createdAt desc. Sort order is not configurable.

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

limit
integer
default:10

Page size. Default 10, maximum 100.

Required range: 1 <= x <= 100
starting_after
string

Cursor — the id of the last event from the previous page.

service_start_time[gt]
string<date-time>

Events whose service_start_time is strictly after this ISO 8601 datetime (must include timezone, e.g. 2026-06-01T00:00:00Z).

service_start_time[gte]
string<date-time>

Events whose service_start_time is at or after this ISO 8601 datetime.

service_start_time[lt]
string<date-time>

Events whose service_start_time is strictly before this ISO 8601 datetime.

service_start_time[lte]
string<date-time>

Events whose service_start_time is at or before this ISO 8601 datetime.

created_at[gt]
string<date-time>

Events created strictly after this ISO 8601 datetime.

created_at[gte]
string<date-time>

Events created at or after this ISO 8601 datetime.

created_at[lt]
string<date-time>

Events created strictly before this ISO 8601 datetime.

created_at[lte]
string<date-time>

Events created at or before this ISO 8601 datetime.

location_id
string

Filter to events at this location.

booking_id
string

Filter to events on this booking.

expand[]
string[]

Inline related objects. On list endpoints each path must be prefixed with data. (e.g. data.booking.lead). Allow-listed paths: data.location, data.services, data.staff, data.addons, data.resources, data.booking, data.booking.lead, data.booking.eventType, data.booking.invoices. Max 20 paths, max depth 4.

Response

Events retrieved successfully

object
enum<string>
required
Available options:
list
url
string
required
Example:

"/api/events"

hasMore
boolean
required

Whether more pages are available. If true, use the id of the last item in data as starting_after to fetch the next page.

data
object[]
required