B2BROKER
B2CORE
B2CORE IB
B2TRADER
B2CONNECT
B2TRANSLATE
B2BROKERUser
Cette page n'est pas disponible en français. La version anglaise est affichée.
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 AuthorizationBearer <token>
In: header
Query Parameters
limit?integer
Maximum number of users to return.
Default
30offset?integer
Offset to start pagination.
Default
0email?string
Filter users by email (partial match).
fullName?string
Filter users by full name (partial match).
fullTextSearch?string
Full-text search across email and full name.
isActive?string
Filter by active status.
Value in
- "true"
- "false"
isConfirmed?string
Filter by confirmation status.
Value in
- "true"
- "false"
isTwoFaActive?string
Filter by 2FA status.
Value in
- "true"
- "false"
roles?string
JSON encoded array of role names to filter by.
tenants?string
JSON encoded array of tenant IDs to filter by.
sort?string
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, "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}" }}