Skip to main content

GET /calendars

Description​

Gets data on all calendars and returns a json object with an array of calendars objects

The route handles the GET request made to the /calendars path.

HTTP methodRoute
GET/calendars

Payload​

No payload is required.

Response​

The route returns a json object with an array of all calendars objects.

Example:

[
    {
        "id": 1,
        "label": "Work",
        "active": true,
        "color": {
            "background": "#3AA3E3",
            "border": "#098CDC"
        },
        "description": ""
    },
    {
        "id": 2,
        "label": "Meeting",
        "active": true,
        "color": {
            "background": "#9585EF",
            "border": "#7A67EB"
        },
        "description": ""
    },
    // ...
]

For another example of the returned object, go to calendars.

The HTTP status code shows whether the request succeeds (response.status == 200) or fails (response.status == 500).

Related articles: