Method: albums.list

Lists all albums shown to a user in the Albums tab of the Google Photos app.

HTTP request

GET https://photoslibrary.googleapis.com/v1/albums

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

number

Maximum number of albums to return in the response. The default number of albums to return at a time is 20. The maximum pageSize is 50.

pageToken

string

A continuation token to get the next page of the results. Adding this to the request returns the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the listAlbums request.

excludeNonAppCreatedData

boolean

If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

List of albums requested.

JSON representation
{
  "albums": [
    {
      object(Album)
    }
  ],
  "nextPageToken": string
}
Fields
albums[]

object(Album)

[Output only] List of albums shown in the Albums tab of the user's Google Photos app.

nextPageToken

string

[Output only] Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/photoslibrary
  • https://www.googleapis.com/auth/photoslibrary.readonly
  • https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata

Try it!