Skip to content

List Calendar Events

GET
/appointments/calendars/events

What is already on the connected Google / Outlook calendars in a window.

This is what makes a slot unavailable, so it is the read to reach for when availability looks wrong. READ-ONLY and display-only: private events come back as “Busy” blocks, and a calendar that fails to load is reported in errors rather than failing the request.

Authorizations

Parameters

Query Parameters

start
required

Window start, ISO-8601.

string format: date-time

Window start, ISO-8601.

end
required

Window end, ISO-8601.

string format: date-time

Window end, ISO-8601.

scope

my for the key owner alone, org for every member who has not opted out. An empty org result means nobody shares a calendar, not that nobody is busy.

string
default: my
Allowed values: my org

my for the key owner alone, org for every member who has not opted out. An empty org result means nobody shares a calendar, not that nobody is busy.

host_emails
Any of:
string

CSV. Narrows org scope to these members.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

A named list ({"events": [...]}) keeps its own key AND gains items, so a generic client can page any of these the same way.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string