Skip to main content
GET
/
api
/
albums
List albums
curl --request GET \
  --url https://api.example.com/api/albums
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "asset_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "album_cover_asset_id": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true
}

Query Parameters

library_id
string | null

Library to list albums from (optional)

asset_id
string | null

Filter albums containing this asset ID (optional)

limit
integer
default:100

Max number of albums to return

Required range: 1 <= x <= 1000
starting_after_id
string | null

Album ID to start listing albums after

Response

Successful Response

data
AlbumResponse · object[]
required
has_more
boolean
required