You are viewing the legacy documentation for the Google Photos Library API.
Method: sharedAlbums.list
Stay organized with collections
Save and categorize content based on your preferences.
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
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 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThis API lists all shared albums accessible through the user's Google Photos Sharing tab.\u003c/p\u003e\n"],["\u003cp\u003eIt supports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for handling large result sets.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of shared albums and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required with one of the specified OAuth scopes, including readonly and app-created data options.\u003c/p\u003e\n"]]],["This document details how to list shared albums from a user's Google Photos library. Use a `GET` request to `https://photoslibrary.googleapis.com/v1/sharedAlbums`. Optional query parameters `pageSize` (default 20, max 50), `pageToken` (for pagination), and `excludeNonAppCreatedData` (default false) modify the results. The request body must be empty. The response includes a list of `sharedAlbums` and a `nextPageToken` for pagination. Authorization requires one of three specified OAuth scopes.\n"],null,["# Method: sharedAlbums.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListSharedAlbumsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all shared albums available in the Sharing tab of the user's Google Photos app.\n\n### HTTP request\n\n`GET https://photoslibrary.googleapis.com/v1/sharedAlbums`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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. |\n| `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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nList of shared albums requested.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"sharedAlbums\": [ { object (/photos/library/legacy/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sharedAlbums[]` | `object (`[Album](/photos/library/legacy/reference/rest/v1/albums#Album)`)` Output only. List of shared albums. |\n| `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. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/photoslibrary`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]
