GET /v1/calendar/calendars/

Searches for calendars by a type (personal/group/shared), returns calendars that the user has access permission.

URL:

http://{domain_name}/{rest_context_name}/private/v1/calendar/calendars/

Supported Format: JSON

Parameters:

Required (path parameters): No
Optional (query parameters):

Parameter	Description
type	Type of calendar, can be personal, group or shared. If omitted or unknown, it searches for all types.
offset	The starting point when paging the result. Default is 0.
limit	Maximum number of calendars returned. If omitted or exceeds the query limit parameter configured for the class, query limit is used instead.
returnSize	Default is false. If set to true, the total number of matched calendars will be returned in JSON, and a "Link" header is added. This header contains "first", "last", "next" and "previous" links.
fields	Comma-separated list of selective calendar attributes to be returned. All returned if not specified.
jsonp	The name of a JavaScript function to be used as the JSONP callback. If not specified, only JSON object is returned.

Request example:

 GET: http://localhost:8080/rest/private/v1/calendar/calendars?type=personal&fields=id,name

Response:

 {
   "limit": 10,
   "data": [
     {
       "editPermission": "",
       "viewPermission": "",
       "privateURL": null,
       "publicURL": null,
       "icsURL": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId/ics",
       "description": null,
       "color": "asparagus",
       "timeZone": "Europe/Brussels",
       "name": "John Smith",
       "type": "0",
       "owner": "john",
       "groups": null,
       "href": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId",
       "id": "john-defaultCalendarId"
     },
     {
       "editPermission": "/platform/users/:*.*;",
       "viewPermission": "*.*;",
       "privateURL": null,
       "publicURL": null,
       "icsURL": "http://localhost:8080/rest/private/v1/calendar/calendars/calendar8b8f65e77f00010122b425ec81b80da9/ics",
       "description": null,
       "color": "asparagus",
       "timeZone": "Europe/Brussels",
       "name": "Users",
       "type": "0",
       "owner": null,
       "groups": [
         "/platform/users"
       ],
       "href": "http://localhost:8080/rest/private/v1/calendar/calendars/calendar8b8f65e77f00010122b425ec81b80da9",
       "id": "calendar8b8f65e77f00010122b425ec81b80da9"
     }
   ],
   "size": -1,
   "offset": 0
 }