REST API Documentation
/calendar/events
Get list of events
For requests using an OAuth Access Token for a particular member, only events the authorized user can view will be included
Parameters
Name | Type | Description |
---|---|---|
ids
|
string | Comma-delimited list of event IDs |
calendars
|
string | Comma-delimited list of calendar IDs |
authors
|
string | Comma-delimited list of member IDs - if provided, only events started by those members are returned |
locked
|
int | If 1, only events which are locked are returned, if 0 only unlocked |
hidden
|
int | If 1, only events which are hidden are returned, if 0 only not hidden |
featured
|
int | If 1, only events which are featured are returned, if 0 only not featured |
rangeStart
|
string | YYYY-MM-DD. Only events occurring on or after this date will be returned. |
rangeEnd
|
string | YYYY-MM-DD. Only events occurring on or before this date will be returned. |
sortBy
|
string | What to sort by. Can be 'date' for creation date, 'start' for event start date, 'end' for event end date, 'title' or leave unspecified for ID |
sortDir
|
string | Sort direction. Can be 'asc' or 'desc' - defaults to 'asc' |
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
Code | Message | Description |
---|---|---|
1L296/M |
INVALID_DATE |
The rangeStart and/or rangeEnd value was not a valid date in YYYY-MM-DD format |
Response
This endpoint doesn't return a response.