Skip to main content
GET
List users

Filtering the list

Narrow the results with query parameters. Filters compose, so you can combine them in a single request.

By email

Pass email to look up a user by email address:
The match is exact and case-insensitive — it is not a substring search — and it checks the user’s primary email as well as any of their other known emails (aliases). A lookup therefore succeeds even when all you have is one of the user’s secondary addresses.

By status

By default the list returns only active users, and an email lookup follows the same rule. To widen the lookup to users who are no longer active — for example offboarded or inactive ones — add status=all:

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your AccessOwl API token in the Authorization header as Bearer <token>.

Query Parameters

limit
integer

Maximum results to return (default: 20, max: 100)

cursor
string

Opaque cursor returned in the previous response's meta.next_cursor. Omit for the first page.

status
enum<string>

Filter users by status. Returns active users by default

Available options:
onboarding_provisioning_planned,
onboarding,
active,
inactive,
offboarding_planned,
offboarding,
offboarded,
all
email
string

Filter users by email. Matches the primary email or any of the user's other known emails (case-insensitive, exact match).

Response

User list

Paginated list of users

data
User · object[]
required

List of users

meta
PaginationMeta · object
required

Pagination metadata

Example:
Last modified on September 12, 2026