Method: albums.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all albums created by your app.
HTTP request
GET https://photoslibrary.googleapis.com/v1/albums
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 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
List of albums requested.
If successful, the response body contains data with the following structure:
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.readonly.appcreateddata
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-01 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-01 UTC."],[[["Lists all albums displayed in the user's Google Photos Albums tab."],["Allows filtering by page size, page token, and excluding non-app created data."],["Responses include an array of albums and a token for retrieving further pages."],["Requires specific authorization scopes for access, with some legacy scopes being phased out."],["Functionality will be limited to app-created media starting March 31, 2025."]]],["This document details how to retrieve a list of albums from the Google Photos app using the `GET https://photoslibrary.googleapis.com/v1/albums` request. The request requires no body but accepts `pageSize`, `pageToken`, and `excludeNonAppCreatedData` as query parameters. The response includes an array of albums and an optional `nextPageToken` for pagination. It also outlines the required authorization scopes and indicates that certain scopes will limit functionality to app-created content after March 31, 2025.\n"]]