Method: sharedAlbums.list

  • This API lists all shared albums accessible through the user's Google Photos Sharing tab.

  • It supports pagination with pageSize and pageToken for handling large result sets.

  • The response provides a list of shared albums and a token for retrieving subsequent pages.

  • Authorization is required with one of the specified OAuth scopes, including readonly and app-created data options.

Lists all shared albums available in the Sharing tab of the user's Google Photos app.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default pageSize is 20, the maximum 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 listSharedAlbums 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

List of shared albums requested.

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

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

object (Album)

Output only. List of shared albums.
nextPageToken

string

Output only. Token to use to get the next set of shared albums. Populated if there are more shared 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