Shared Link Viewer
Anonymous endpoints used by the page that opens a share link. They need no GeoPulse account. Read the link info, get a short-lived access token (sending the password for protected links), and send it as Authorization: Bearer <token> on the other requests. Live-location links and timeline links expose different endpoints.
📄️ Get share link info
Returns what a share link shows: its type, name, owner, shared period, display options, and whether a password is required. Does not need an access token.
📄️ Get an access token
Returns a short-lived access token for a share link, to send as `Authorization: Bearer <token>` on the other viewer endpoints. For password-protected links, send the password; otherwise the password can be empty.
📄️ Get the owner's current location
Returns the owner's latest location, when the timeline link is set to show the current location. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Get the shared live location
Returns the current location of the link owner and, if the link includes history, their recent movement. Live-location links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Get shared notes
Returns the owner's notes in the shared period, when the link includes notes. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Get the shared GPS path
Returns the owner's GPS path in the shared period for drawing on a map. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ List shared photos
Returns the owner's Immich photos taken in the shared period (or from the selected album), when the link includes photos. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Download a shared photo
Downloads the original file of a shared photo. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Get a shared photo preview
Returns a larger JPEG preview of a shared photo. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Get a shared photo thumbnail
Returns a small JPEG thumbnail of a shared photo. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.
📄️ Get the shared timeline
Returns the stays, trips, and data gaps of the shared period. Timeline links only. Requires the access token from `POST /api/v1/public/share-links/{linkId}/access-tokens`.