This document is generated by Aladia.

Retreive Private Events

Testing

POST

/calendars/private-events/{profileId}

This endpoint retrieves a sanitized list of personal events from the user's calendar. When the "Personal Events" toggle is enabled, the backend returns events that belong to the user's personal calendar. Since these are private events, only the date of each event is provided, with the title set to "Not Available" and all other fields nullified. These events are displayed solely to indicate when the user is occupied, and they cannot be opened or interacted with.

calendarIds refers to the currently selected calendar , so on the santized event we will return all events on users calendar that does not found on the calendar of calendarIds list(because they are already visible)

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.aladia.io/v2/calendars/private-events/?limit=50' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "calendarIds": ["66c0c4e7d4b7ab27339fd07d","66c0c4e6d4b7ab27339fd07a"]
}'

Response Example

201 - Success

{
    "data": [
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-01T05:45:00.000Z",
                "endDate": "2024-09-01T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-01T05:45:00.000Z",
                "endDate": "2024-09-01T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-01T05:45:00.000Z",
                "endDate": "2024-09-01T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-01T05:45:00.000Z",
                "endDate": "2024-09-01T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-02T05:45:00.000Z",
                "endDate": "2024-09-02T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-02T05:45:00.000Z",
                "endDate": "2024-09-02T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-03T05:45:00.000Z",
                "endDate": "2024-09-03T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-03T05:45:00.000Z",
                "endDate": "2024-09-03T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-04T05:45:00.000Z",
                "endDate": "2024-09-04T06:00:00.000Z"
            }
        },
        {
            "name": "Not Available",
            "dates": {
                "startDate": "2024-09-04T05:45:00.000Z",
                "endDate": "2024-09-04T06:00:00.000Z"
            }
        }
    ],
    "cursor": {
        "next": "eyJpZCI6IjY2YzM2YjJiYjBmZjZlOTAzMjc2NjhlNiIsImRpcmVjdGlvbiI6ImFzYyJ9",
        "prev": null,
        "totalItems": 12
    }
}

Request

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-02-28 08:06:18

Update a Calendar

Add to Selected Calendars