Skip to main content
GET
Get the current user

Authorizations

Authorization
string
header
required

Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.

Response

Successful Response

Represents a user account with profile information.

id
string
required

Unique user identifier with 'intuser_' prefix

favorite_display_mode
enum<string>
required

The user's effective favorite/rating display mode, defaulting to favorite when they have never selected one.

Available options:
favorite,
rating
demo_mode_enabled
boolean
required

Whether demo-mode person-name presentation is enabled. Defaults to false.

face_detection_preference
boolean | null
required

Whether automatic face detection is on for the libraries this user owns: true is on, false is off, null means the user has not chosen yet. Faces are currently detected automatically when this is true or null.

face_detection_available
boolean
required

Whether automatic face detection can be turned on for this user. False when the declared home region is one where it is not offered; face_detection_preference is then false and cannot be set to true.

is_active
boolean
required

Whether this user account is currently active

is_superuser
boolean
required

Whether this user has superuser/admin privileges

is_verified
boolean
required

Whether the account is marked verified. An internal account flag, not proof of email verification — it can be true even when email is null

storage_used_bytes
integer
required

Total bytes of assets the user is currently storing

storage_limit_bytes
integer
required

Maximum bytes of assets the user may store

created_at
string<date-time>
required

When this user account was created

updated_at
string<date-time>
required

When this user account was last updated

email
string | null

User's email address

first_name
string | null

User's first name

last_name
string | null

User's last name

timezone
string | null

User's home timezone as an IANA zone id (e.g. 'America/Los_Angeles'); null until a home zone is captured

immich_library_id
string | null

The user's stored preferred library, or null to use the default. Reported as stored: the library may since have been trashed, or the user's access to it may have changed.

home_country
string | null

The user's declared home country as an ISO 3166-1 alpha-2 code (e.g. 'US'); null until declared

home_subdivision
string | null

The user's declared home state or province: an ISO 3166-2 code without its country prefix (e.g. 'CA' for US-CA); null when not declared