Skip to main content

API key permissions

Select these permissions when creating an Immich API key for Immich Gallery.

Partial permission sets are untested. You may choose to omit permissions for features you do not use, such as tag.read when you do not use tags.

Last updated July 24, 2026

Required permissions

album.read
Browse personal and shared albums, read the optional slideshow configuration album, and check selected album details.
asset.download
Load full-resolution originals in the viewer and slideshow.
asset.read
Browse, search, filter, load asset metadata, and select images for slideshows.
asset.statistics
Display library statistics.
asset.view
Load thumbnails, previews, video playback, and server-converted RAW previews in slideshows.
folder.read
Browse external library folders.
person.read
Browse people and person thumbnails.
stack.read
Open stacked photos. Required for Timeline.
tag.read
Browse tags.
user.read
Validate the key and load the current user.
userProfileImage.read
Display account profile images.