Email, calendar & files · Calendar

List calendars

Returns calendars.

GEThttps://api.pozy.ai/v1/calendar/calendars
listCalendars

Guides: Calendar, Email, calendar & files, Google Workspace

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the calendar resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

NameTypeNotes
accountIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/calendar/calendars?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • dataarray of object
    8 child fields
    • idstring
    • accountIdstring
    • providerstring

      One of google, microsoft.

    • namestring
    • primaryboolean
    • timezonestring

      Can be null.

    • colorstring

      Can be null.

    • readOnlyboolean
200 response
{
  "data": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "accountId": "696e0b682d0a31188e7a2ba9",
      "provider": "google",
      "name": "Acme",
      "primary": true,
      "timezone": "America/New_York",
      "color": "string",
      "readOnly": true
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Calendar