Skip to main content
GET
List users in the administrator's organization

Authorizations

Authorization
string
header
required

OAuth 2.0 access token obtained through RFC 8628 at /api/auth/device/code and /api/auth/oauth2/token. The API enforces governance:read, session:write, and client-status:write as appropriate.

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100
q
string

Case-insensitive email or subject substring

Maximum string length: 200
role
enum<string>
Available options:
admin,
member
status
enum<string>
Available options:
active,
suspended,
removed
provisioning_source
enum<string>
Available options:
local,
scim

Response

Users

items
object[]
required
page
integer
required
Required range: x >= 1
per_page
integer
required
Required range: 1 <= x <= 100
total
integer
required
Required range: x >= 0
total_pages
integer
required
Required range: x >= 0