Get calendar events

Returns events that are a part of a particular calendar.

HTTP Method: GET
Endpoint: /rest-api/1/event-calendar/calendars/{uuid}/events

Replace {uuid} with the unique identifier of the calendar.
Note: only events created by this API calls are currently returned by this endpoint.

Request example:

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

Response example:

{
    "status": true,
    "data": [
        {
            "id": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "Daily standup",
            "description": "Our regular monday morning standup",
            "url": null,
            "color": null,
            "starting_date": "2025-01-06",
            "ending_date": "2025-01-06",
            "starting_time": "08:30",
            "ending_time": "09:00",
            "event_type": {
                "id": 1000,
                "name": "Regular event"
            }
        },
        {
            "id": 'xxxx...',
            "name": "Workshop",
            ...
        }
    ]
}

Response data contents

Key	Type	Nullable	Description
id	string	No	Unique identifier for the calendar (UUID format).
name	string	No	Name of the event (e.g., “Meeting”).
description	string	Yes	Description for the event.
url	string	Yes	Url for the event.
color	string	Yes	Represents the associated color (e.g., “#FF5733”), or null if no color is assigned.
starting_date	string	No	Date on which the event starts.
ending_date	string	No	Date on which the event ends. For “one-day-event” is the value the same as with starting_date.
starting_time	string	Yes	Starting time of the event. Forma: H:i.
ending_time	string	Yes	Ending time of the event. Forma: H:i.
event_type	object	No	Event type details. `{id: XXX, name: XXX}`