Retrieve preview photos for a specific album

GET/album/getPreviewPhotos

Preview photos are a subset of the album's photos (max. 32 photos) that anyone can view when the preview feature is ON for that album

Authentication

Include your API key in the x-api-key header on every request.

Query parameters

albumIdstringrequired

Response · 200 Preview photos retrieved successfully

dataArray<PreviewPhoto>required

object

photoIdstringrequired

widthinteger

heightinteger

originalUrlstringrequired

A signed URL to access the originally uploaded image

stableUrlstringrequired

A signed URL to access the stable version of the image (JPEG or WebP, <15 MB)

warningsArray<string>

string

Errors

404Album not found

TypeScript SDKts

import { SwshApiClient } from "@somewhere-somehow/swsh-public-api";

const client = new SwshApiClient({ apiKey: process.env.SWSH_API_KEY! });

const result = await client.album.getPreviewPhotos({
  albumId: "22222222-2222-2222-2222-222222222222"
});

cURLbash

curl "https://public-api.joinswsh.com/album/getPreviewPhotos?albumId=22222222-2222-2222-2222-222222222222" \
  -H "x-api-key: $SWSH_API_KEY"

Example response

{"data": [{"photoId": "string",
"width": 0,
"height": 0,
"originalUrl": "string",
"stableUrl": "string"
}
],
"warnings": ["Example warning"
]
}