Skip to main content
GET
List scheduled events

Authorizations

Authorization
string
header
required

Query Parameters

sort
enum<string>
default:asc

Order results based on the startTime.

Available options:
asc,
desc
count
number
default:20

Limit the number of returned results per page.

Required range: 1 <= x <= 100
status
enum<string>

Filter based on event status. Possible values are: active, cancelled. Omit for all events.

Available options:
confirmed,
cancelled
minStartTime
string<date-time>

Filter for events starting after the specified time.

Example:

"2026-04-01T00:00:00.000000Z"

maxStartTime
string<date-time>

Filter for events starting before the specified time.

Example:

"2026-04-30T23:59:59.000000Z"

scope
enum<string>

Filters results based on the scope. Currently only 'all' is supported, returning all events of the whole organization. More options coming soon.

Available options:
all
userSlug
string

Filter for events hosted by a specific user in your organization based on the user's slug.

Example:

"lena-meier"

hostEmail
string<email>

Filter for events hosted by a specific user in your organization based on the user's email address.

Example:

"lena.meier@horizondigital.de"

inviteeEmail
string<email>

Filter for events of a specific invitee by their email address.

Example:

"sophie.laurent@northwind.io"

teamSlug
string

Filter for events that belong to a specific team in your organization based on the team's slug.

keyword
string

Case-insensitive search across the invitee name, the invitee email, the answers to booking questions, and the values of custom query parameters. The keyword matches any part of a field, and an event is returned if any of its confirmed invitees matches. Custom query parameter names are not searched, only their values. For reconciliation, use customQueryParams instead: the keyword matches partial text, so EYE-PROBE-0002 also returns an event tagged EYE-PROBE-00021.

customQueryParams
object

Filter for events whose custom query parameter carries exactly this value. The value must match in full, so EYE-PROBE-0002 never returns an event tagged EYE-PROBE-00021. Write the parameter name with or without its c__ prefix — c__ticket and ticket name the same parameter, because every name here is one. Combine at most three parameters across customQueryParams and hasCustomQueryParams; they are AND-ed. Example: ?customQueryParams[c__ticket]=EYE-PROBE-0002. Send an empty value to match the events tagged with an empty one. Values are stored with any HTML tags removed, so match against the stored value: a booking tagged size<10 is stored as size.

Example:
hasCustomQueryParams
string[]

Filter for events that carry the named custom query parameter at any value, including an empty one. The name takes the c__ prefix or leaves it off, as in customQueryParams. Counts towards the same limit of three as customQueryParams. Repeat the name in brackets — ?hasCustomQueryParams[]=c__region, or the indexed form ?hasCustomQueryParams[0]=c__region. A bare repeated key (?hasCustomQueryParams=a&hasCustomQueryParams=b) collapses to the last value and is rejected.

Maximum array length: 3
Maximum string length: 100
Example:
page
number

Page number for paginated results.

Required range: x >= 1
eventTypeId
string

Filter for events that belong to a specific event type, identified by its ID.

Response

OK

pagination
object
required
collection
object[]
Last modified on April 29, 2026