Hide

CalendarList: get

Requires authorization

Returns an entry on the user's calendar list. Try it now or see an example.

Request

HTTP request

GET https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId

Parameters

Parameter name Value Description
Path parameters
calendarId string 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.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a CalendarList resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Retrieve a specific calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

System.out.println(calendarListEntry.getSummary());

Python

Uses the Python client library.

calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()

print calendar_list_entry['summary']

PHP

Uses the PHP client library.

$calendarListEntry = $service->calendarList->get('calendarId');

echo $calendarListEntry->getSummary();

Ruby

Uses the Ruby client library.

result = client.execute(:api_method => service.calendar_list.get,
                        :parameters => {'calendarId' => 'calendarId'})
print result.data.summary

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Google Calendar API