Sign in
Users

Get all users

Retrieve a list of all users on the server.

get/users

Request

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

Response

avatarColor'primary' | 'pink' | 'red' | 'yellow' | 'blue' | 'green' | 'purple' | 'orange' | 'gray' | 'amber' required

User avatar color

emailstring email required

User email

idstring uuid required

User ID

namestring required

User name

profileChangedAtstring date-time required

Profile change date

profileImagePathstring required

Profile image path

Changes

No recorded changes to this operation across all 50 revisions of this API.