🗓️Calendars

Microsoft Outlook Calendars

Get All Calendars

GET https://api.pyas.io/microsoft/calendars

Gets all calendars that a user has access to.

Query Parameters

Name
Type
Description

accountId*

String

The user's Pyas account id. This is returned when you connect an account to Pyas.

Headers

Name
Type
Description

x-api-key*

String

API key

{
    "success": true,
    "data": {
        "calendars": [
            {
                "id": "some-calendar-id",
                "name": "Calendar",
                "color": "auto",
                "hexColor": "",
                "isDefaultCalendar": true,
                "changeKey": "some-key",
                "canShare": true,
                "canViewPrivateItems": true,
                "canEdit": true,
                "allowedOnlineMeetingProviders": [
                    "skypeForConsumer"
                ],
                "defaultOnlineMeetingProvider": "skypeForConsumer",
                "isTallyingResponses": true,
                "isRemovable": false,
                "owner": {
                    "name": "Jane Doe",
                    "address": "[email protected]"
                }
            }
        ]
    }
}

Get Calendar by ID

GET https://api.pyas.io/microsoft/calendars/{id}

Gets a calendar by id

Path Parameters

Name
Type
Description

{id}*

String

The id of the calendar to retrieve

Query Parameters

Name
Type
Description

accountId*

String

The user's Pyas account id. This is returned when you connect an account to Pyas

Headers

Name
Type
Description

x-api-key*

String

API key

{
    "success": true,
    "calendar": {
        "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('[email protected]')/calendars/$entity",
        "id": "some-calendar-id",
        "name": "Calendar",
        "color": "auto",
        "hexColor": "",
        "isDefaultCalendar": true,
        "changeKey": "some-key",
        "canShare": true,
        "canViewPrivateItems": true,
        "canEdit": true,
        "allowedOnlineMeetingProviders": [
            "skypeForConsumer"
        ],
        "defaultOnlineMeetingProvider": "skypeForConsumer",
        "isTallyingResponses": true,
        "isRemovable": false,
        "owner": {
            "name": "Jane Doe",
            "address": "[email protected]"
        }
    }
}
PreviousAuthNextEvents

Last updated