Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Query Parameters

tenant_id
string<uuid>

List users of this tenant and the tenants beneath it. Defaults to your own tenant. Must be your own tenant or one beneath it.

Matches users whose email, first name, last name or tenant name contains this text, ignoring case.

status
string

Only active users (who can sign in) or only disabled users.

sort
string

login_asc, login_desc, status_asc or status_desc. The login sorts order by last_login_at: users who never signed in come first with login_asc and last with login_desc.

page

The page to return, starting at 1 (the default).

page_size

Items per page: 1–100, default 50.

Response

OK

One page of users, ordered by email. There is one item per user and tenant, so a user with access to several tenants appears more than once, and total_count counts those items.

items
object[]
required

The users on this page. Empty when nothing matches.

page
required

The page number returned, starting at 1.

page_size
required

The maximum number of items per page, as requested (default 50, maximum 100).

total_count
required

The number of items that match across all pages.

next_page

The page to request next. Null when this is the last page.