Admin

List Users

List users with optional status, role, search, and sort filters (admin only).

sort and order are closed enums, so an unrecognised value is refused with a 422 and never reaches the query.

get/admin/users/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

skipinteger
limitinteger
statusstring nullable
role'admin' | 'editor' | 'viewer' nullable

Assigned role membership to match.

searchstring nullable
sort'username' | 'email' | 'status' | 'last_login_at' | 'created_at'

Column to order by. Roles and storage are not sortable: roles is a many-to-many and storage is aggregated per page after the query.

order'asc' | 'desc'

Sort direction.

Response

Successful Response

totalinteger required

Total number of users matching the query (across all pages).

Changes

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