List calendar events

Returns the active (not canceled) events the token's user can see, in start-time order, for the
period around date that view selects:

  • month: the whole month, padded to full Sunday-to-Saturday weeks
  • week: the Sunday-to-Saturday week
  • day: that day only
  • list: the next 50 events starting that day

Users who can see all records get every user's events; everyone else gets their own, those of the
people they manage, and their crew's. Events mirrored in from another user's personal calendar
appear as busy blocks with the details withheld, unless that user shares calendar details. Send
summary=true to get only each event's id and start_time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Period to return: month (default), week, day or list.

string

Date the period is built around, as YYYY-MM-DD. Defaults to today.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json