Sign in

v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
admins

Get admins

Returns an array with one or more admins. For security reasons hashed passwords are omitted in the response

get/admins

Query parameters

offsetinteger
limitinteger

The maximum number of items to return. Max value is 500, default is 100

order'ASC' | 'DESC'
Example:ASC

Ordering admins by username. Default ASC

Response

successful operation

idinteger
status0 | 1

status:

  • 0 user is disabled, login is not allowed
  • 1 user is enabled
usernamestring

username is unique

descriptionstring

optional description, for example the admin full name

passwordstring password

Admin password. For security reasons this field is omitted when you search/get admins

emailstring email
permissionsAdminPermissions[]
additional_infostring

Free form text field

created_atinteger

creation time as unix timestamp in milliseconds. It will be 0 for admins created before v2.2.0

updated_atinteger

last update time as unix timestamp in milliseconds

last_logininteger

Last user login as unix timestamp in milliseconds. It is saved at most once every 10 minutes

rolestring

If set the admin can only administer users with the same role. Role admins cannot have the "*" permission

Example response

[
  {
    "filters": {
      "allow_list": [
        "192.0.2.0/24",
        "2001:db8::/32"
      ]
    }
  }
]