B2BROKERB2BROKER
MCP
B2COREB2CORE IBB2TRADERB2CONNECTB2TRANSLATEB2BROKER
User

Get users list

Returns users with optional filtering by email, status, roles, and tenants. Pagination and sorting mirror v1 behaviour with updated tenant support.

GET
/api/v2/users

Authorization

BearerAuthObject
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Maximum number of users to return.

Default30
offset?integer

Offset to start pagination.

Default0
email?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}"  }}
PreviousRenew personal API token PATCHNextCreate user POST