Retrieve a specific album

GET/album/getAlbum

Authentication

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

Query parameters

albumIdstringrequired

Response · 200 Album retrieved successfully

dataobjectrequired

albumIdstringrequired

namestringmin 1max 40

ownerIdstring

shareUrlstring

A URL that can be shared with others to view the album. This URL is static and will always point to the album. You can safely cache this URL for future use.

numPhotosinteger

The number of photos in the album

numParticipantsinteger

The number of participants in the album (inclusive of the album owner)

warningsArray<string>

string

Errors

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

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.getAlbum({
  albumId: "22222222-2222-2222-2222-222222222222"
});

cURLbash

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

Example response

{"data": {"albumId": "22222222-2222-2222-2222-222222222222",
"name": "My Album",
"ownerId": "11111111-1111-1111-1111-111111111111",
"shareUrl": "https://joinswsh.com/album/abcdef",
"numPhotos": 5,
"numParticipants": 2
},
"warnings": ["Example warning"
]
}