List users in the caller's tenant
Returns a paginated list of users (identities) in the caller's tenant. Supports free-text search on email and display_name, plus an optional status filter.
Returns a paginated list of users (identities) in the caller's tenant. Supports free-text search on email and display_name, plus an optional status filter.
Authorization
bearerAuth JWT Bearer access token. Clock skew tolerance is ±60 seconds.
In: header
Query Parameters
11 <= value201 <= value <= 100Optional filter by user status. Omit for all users. Deleted users are never returned, so deleted is not accepted.
"active" | "suspended"Column to order users by. Defaults to created_at descending. The aggregated role and group columns are not sortable and return 400 invalid_sort_key.
"created_at" | "email" | "display_name" | "status"Sort direction. Ignored unless sort is supplied; an unrecognised value returns 400 invalid_sort_order.
"asc" | "desc"Response Body
application/json
application/json
curl -X GET "https://example.com/v1/admin/users?status=active&sort=email&order=asc"{
"users": [
{
"id": "018f1a2b-0001-7000-8000-000000000001",
"email": "[email protected]",
"display_name": "Alice",
"status": "active",
"created_at": "2026-01-15T08:00:00Z",
"roles": [
{
"role_id": "018f1a2b-0001-7000-8000-000000000020",
"role_key": "tenant_admin",
"role_name": "Tenant Admin"
}
],
"groups": [
{
"group_id": "018f1a2b-0001-7000-8000-000000000030",
"group_name": "Finance"
}
]
}
],
"total": 0
}{
"error": "unauthenticated",
"message": "missing or invalid bearer token",
"request_id": "req_01abc123"
}Was this page helpful?