Skip to content

Calendars

2 endpoints

Calendar access and event retrieval

GET /accounts/{accountId}/calendars

GET /accounts/{accountId}/calendars

Parameters

accountId string

In path Required

Additional parameters
page string

In query Optional

limit string

In query Optional

maxResults string

In query Optional

pageToken string

In query Optional

Returns

Paginated list of calendars available to the account.

Content type: application/json

Status: 200

Example request
                
                    
                    curl -X GET "http://localhost:8080/accounts/{accountId}/calendars"
                  
              
Example response 200

              {
  "calendars": [
    {
      "id": "cal_primary",
      "summary": "Primary Calendar",
      "description": "Default calendar for the account.",
      "timeZone": "America/New_York",
      "backgroundColor": "#2952a3",
      "foregroundColor": "#ffffff",
      "accessRole": "owner",
      "primary": true,
      "selected": true,
      "provider": "google"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}
            

GET /accounts/{accountId}/calendars/{calendarId}/events

GET /accounts/{accountId}/calendars/{calendarId}/events

Parameters

accountId string

In path Required

calendarId string

In path Required

Additional parameters
page string

In query Optional

limit string

In query Optional

maxResults string

In query Optional

timeMin string

In query Optional

timeMax string

In query Optional

singleEvents string

In query Optional

orderBy string

In query Optional

pageToken string

In query Optional

q string

In query Optional

Returns

Paginated list of calendar events.

Content type: application/json

Status: 200

Example request
                
                    
                    curl -X GET "http://localhost:8080/accounts/{accountId}/calendars/{calendarId}/events"
                  
              
Example response 200

              {
  "events": [
    {
      "id": "evt_01J0AGD5EFD9F5A6W1X6NS3J3C",
      "summary": "Customer onboarding call",
      "start": {
        "dateTime": "2024-07-01T15:00:00.000Z",
        "timeZone": "UTC"
      },
      "end": {
        "dateTime": "2024-07-01T16:00:00.000Z",
        "timeZone": "UTC"
      },
      "status": "confirmed",
      "provider": "google",
      "calendarId": "primary"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}