Sign in
Albums

List all albums

Changed on

Retrieve a list of albums available to the authenticated user.

get/albums

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/albums
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

assetIdstring uuid

Filter albums containing this asset ID (ignores other parameters)

idstring uuid

Album ID

isOwnedboolean

Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter

isSharedboolean

Filter by shared status: true = only shared, false = not shared, undefined = no filter

namestring

Album name (exact match)

Response

albumNamestring required

Album name

albumThumbnailAssetIdstring uuid nullable required

Thumbnail asset ID

assetCountinteger required

Number of assets

createdAtstring date-time required

Creation date

descriptionstring required

Album description

endDatestring date-time

End date (latest asset)

hasSharedLinkboolean required

Has shared link

idstring uuid required

Album ID

isActivityEnabledboolean required

Activity feed enabled

lastModifiedAssetTimestampstring date-time

Last modified asset timestamp

order'asc' | 'desc'

Asset sort order

sharedboolean required

Is shared album

startDatestring date-time

Start date (earliest asset)

updatedAtstring date-time required

Last update date

Changes

  • 2cd7bd44a940Revision changes
    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the /// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • e1b01b1d6b38Revision changes
    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter name