You are viewing the legacy documentation for the Google Photos Library API.
Method: sharedAlbums.get
Stay organized with collections
Save and categorize content based on your preferences.
Returns the album based on the specified shareToken.
HTTP request
GET https://photoslibrary.googleapis.com/v1/sharedAlbums/{shareToken}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
shareToken |
string
Required. Share token of the album to be requested.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Album.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/photoslibrary.sharing
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.
[[["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 2024-10-09 UTC."],[[["\u003cp\u003eRetrieves a shared album using its unique \u003ccode\u003eshareToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns the album details in the response.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eGET\u003c/code\u003e HTTP method and requires \u003ccode\u003ephotoslibrary.sharing\u003c/code\u003e authorization scope.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint follows gRPC Transcoding syntax for the URL structure.\u003c/p\u003e\n"]]],["The core content describes how to retrieve an album using a share token. A `GET` request is sent to the specified URL, including the required `shareToken` as a path parameter. The request body must be empty. A successful response returns an `Album` instance. This operation requires the `https://www.googleapis.com/auth/photoslibrary.sharing` authorization scope, as defined for sharing. There is also a try it option available to users.\n"],null,["# Method: sharedAlbums.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the album based on the specified `shareToken`.\n\n### HTTP request\n\n`GET https://photoslibrary.googleapis.com/v1/sharedAlbums/{shareToken}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------|\n| `shareToken` | `string` Required. Share token of the album to be requested. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Album](/photos/library/legacy/reference/rest/v1/albums#Album).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/photoslibrary.sharing`"]]
