Retrieve all albums the caller has access to

GET /album/getAlbums
Api key auth

Query parameters

  • limit integer

    The maximum number of albums to retrieve

  • cursor string

    A cursor received from a previous request to retrieve the next page of results

Responses

  • 200 application/json

    Albums retrieved successfully

    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • albumId string Required
      • name string
      • ownerId string
      • shareUrl string

        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.

    • cursor string

      A cursor to be used in subsequent requests to retrieve the next page of results. If this is {}, there are no more results to retrieve.

    • warnings array[string]
  • 400 application/json

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

    Hide response attribute Show response attribute object
GET /album/getAlbums 
curl \
 --request GET 'https://public-api.joinswsh.com/album/getAlbums' \
 --header "x-api-key: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "albumId": "22222222-2222-2222-2222-222222222222",
      "name": "My Album",
      "ownerId": "11111111-1111-1111-1111-111111111111",
      "shareUrl": "https://joinswsh.com/album/abcdef"
    }
  ],
  "cursor": "string",
  "warnings": [
    "Example warning"
  ]
}
Response examples (400) 
{
  "message": "Invalid request"
}