GET
/api/v2/usersList users with filtering and pagination
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| pageNumber (query) | unknown | No | Page number (default: 1) |
| pageSize (query) | unknown | No | Page size (default: 10, max: 100) |
| query (query) | string | No | Search query for email, name, or external user ID |
| status (query) | AccountStatusV2 | No | Filter by user status |
| kycStatus (query) | KycStatusV2 | No | Filter by KYC status |
| externalUserId (query) | string | No | Filter by external user ID |
| dateFrom (query) | string | No | Filter by creation date from |
| dateTo (query) | string | No | Filter by creation date to |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Users | array of UserResponseV2 | No | |
| Total | unknown | No | |
| PageNumber | unknown | No | |
| PageSize | unknown | No | |
| TotalPages | unknown | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X GET "https://{base_url}/api/v2/users" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.