Retrieve preview photos for a specific album

GET /album/getPreviewPhotos
Api key auth

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

Query parameters

  • albumId string Required

    ID of the album to retrieve preview photos for

Responses

  • 200 application/json

    Preview photos retrieved successfully

    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • photoId string Required
      • width integer
      • height integer
      • originalUrl string Required

        A signed URL to access the originally uploaded image

      • stableUrl string Required

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

    • warnings array[string]
  • 400 application/json

    Invalid request. The request was malformed or missing required parameters.

    Hide response attribute Show response attribute object
    • message string Required
  • 404

    Album not found

GET /album/getPreviewPhotos 
curl \
 --request GET 'https://public-api.joinswsh.com/album/getPreviewPhotos?albumId=22222222-2222-2222-2222-222222222222' \
 --header "x-api-key: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "photoId": "string",
      "width": 42,
      "height": 42,
      "originalUrl": "string",
      "stableUrl": "string"
    }
  ],
  "warnings": [
    "Example warning"
  ]
}
Response examples (400) 
{
  "message": "Invalid request"
}