Get users list
Returns users with optional filtering by email, status, roles, and tenants. Pagination and sorting mirror v1 behaviour with updated tenant support.
Authorization
BearerAuthObject Machine tokens only: a personal API token or a product robot token (POST /api/v2/products/{uid}/robot-tokens). A session JWT here is 401 — the web app uses the b2t_access cookie.
In: header
Query Parameters
Maximum number of users to return.
30Offset to start pagination.
0Filter users by email (partial match).
Filter users by full name (partial match).
Full-text search across email and full name.
Filter by active status in the current workspace (account active and its membership here active).
Value in
- "true"
- "false"
Filter by confirmation status.
Value in
- "true"
- "false"
Filter by 2FA status.
Value in
- "true"
- "false"
JSON encoded array of role names to filter by.
JSON encoded array of tenant IDs to filter by.
Sort expression. Supports core fields and tenantsCount.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/users"{ "users": [ { "id": 11, "email": "user@example.com", "fullName": "John Doe", "isActive": true, "blockedEverywhere": false, "isConfirmed": true, "isTwoFaActive": false, "deletedAt": null, "tenantsCount": 2, "roles": [ "Administrator" ], "actions": [ "UserUpdate", "UserDelete" ] } ], "pagination": { "maxCount": 120 }}{ "message": { "error": "Your request was made with invalid credentials." }}{ "message": { "error": "You are not allowed to perform this action." }}{ "message": { "error": "Oops! Something went wrong! Write to administrator. Your Request Id {f1177aee-9a99-42f0-a23f-4dd29fc39b65-672e0df972ccb}" }}