GOgoogle
calendars

GET /calendars/{calendarId}

Changed on

Returns metadata for a calendar.

Request

  • Base URL
    https://www.googleapis.com/calendar/v3
  • URL
    https://www.googleapis.com/calendar/v3/calendars/{calendarId}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.app.created
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.app.created
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.calendars
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.calendars
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.calendars.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.calendars.readonly
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/calendar.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/calendar.readonly

Path parameters

calendarIdstring required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

Response

Successful response

autoAcceptInvitationsboolean

Whether this calendar automatically accepts invitations. Only valid for resource calendars.

dataOwnerstring

The email of the owner of the calendar. Set only for secondary calendars. Read-only.

descriptionstring

Description of the calendar. Optional.

etagstring

ETag of the resource.

idstring

Identifier of the calendar. To retrieve IDs call the calendarList.list() method.

kindstring

Type of the resource ("calendar#calendar").

locationstring

Geographic location of the calendar as free-form text. Optional.

summarystring

Title of the calendar.

timeZonestring

The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

Changes

  • 54e6985ee63dRevision changes
    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2c

  • 66a1fabee696Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/calendar.readonly was removed from the endpoint's security scheme Oauth2c