V1 - Users

List Users

The tenant's users, sorted by email. Requires a system key with users:read.

get/v1/admin/users

Request

  • Base URL
    https://api.app.noxus.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-Key

Query parameters

searchstring nullable

Email or name contains

status'active' | 'pending' | 'suspended' nullable
workspace_idstring uuid nullable
limitinteger nullable

Page size; every user when omitted

offsetinteger

Response

Successful Response

idstring required
emailstring required
display_namestring nullable
tenant_adminboolean required
is_activeboolean required
status'active' | 'pending' | 'suspended' required
tenant_role_idstring nullable
tenant_rolestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.