Skip to main content
GET
List a calendar's events

Authorizations

x-token
string
header
required

Path Parameters

calendarId
string
required

Calendar id from GET /api/calendars.

Query Parameters

q
string

Only events whose title contains this text (case-insensitive).

Required string length: 1 - 200
from
string<date-time>

Window start. Default now.

to
string<date-time>

Window end. Default from + 7 days. Windows longer than 180 days are capped (see range).

limit
integer
default:20

Max events returned, earliest first. No paging; narrow the window for more.

Required range: 1 <= x <= 50
userId
string

Acting user. Required with an API key or partner token; a delegate token is its own user.

Response

Events in the window.

data
object[]
range
object

The window actually searched (after defaults and the 180-day cap).