v1

latestOpenAPI 3.0.02026-08-063014193.1 MB

Calendars

Return the data for all Calendars

Outlines the parameters, optional and required, used when requesting the data for all Calendars

get/calendars.json

created_sincestring date-time

Filter Calendar records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

filter_inactive_usersboolean

Filter any shared UserCalendar records whose owner is inactive.

ids[]integer

Filter Calendar records to those having the specified unique identifiers.

limitinteger

A limit on the number of Calendar records to be returned. Limit can range between 1 and 200. Default: 200.

order'name(asc)' | 'name(desc)' | 'id(asc)' | 'id(desc)'

Orders the Calendar records by the given field. Default: id(asc).

ownerboolean

Filter Calendar records to those that the user owns.

page_tokenstring

A token specifying which page to return.

source'web' | 'mobile'

Filter Calendar records to those having a specific calendar visibility source (mobile, web).

type'AccountCalendar' | 'AdhocCalendar' | 'UserCalendar'

Filter Calendar records to those of the specified type.

updated_sincestring date-time

Filter Calendar records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

visibleboolean

Filter Calendar records to those that are visible.

writeableboolean

Filter Calendar records to those which the user can write to.

X-API-VERSIONstring

The API minor version. Default: latest version.