Jump to content

REST API Documentation

/calendar/calendars


Get list of calendars

For requests using an OAuth Access Token for a particular member, only calendars the authorized user can view will be included


Parameters

Name Type Description
clubs int 0|1 Include club calendars, default: 1
page int Page number
perPage int Number of results per page - defaults to 25

Exceptions

This endpoint doesn't throw any exceptions.

Response

Name Type Description
page int The page number for the results being shown
perPage int The number of results that will be on each page
totalResults int The total number of results
totalPages int The number of pages of results
results array of calendar objects The results for this page

calendar object

Name Type Description
id int ID number
name string Name
url string URL
class string Node class
parentId int|null Parent Node ID
permissions object|null Node permissions
×
×
  • Create New...