Returns all calendars with their details.

  • HTTP Method: GET
  • Endpoint: /rest-api/1/event-calendar/calendars

Request example:

fetch("https://<site-url>/rest-api/1/event-calendar/calendars", {
method: "GET",
headers: {
"X-AldevaDigital-Rest-Token": "your-access-token",
"Content-Type": "application/json",
},
});

Response example:

{
"status": true,
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Team Calendar",
"color": "#FF5733",
"timezone": "America/New_York"
},
{
"id": "987e6543-b21b-65d4-c789-426614170999",
"name": "Project Calendar",
"color": null,
"timezone": "Europe/London"
}
]
}

Response data contents

Explanation of Keys

KeyTypeNullableDescription
idstringNoUnique identifier for the calendar (UUID format).
namestringNoName of the calendar.
colorstring or nullYesColor associated with the calendar (e.g., "#FF5733"), or null if not set.
timezonestringNoTimezone of the calendar (must match IANA Time Zone Database).