B2BROKER
B2CORE
B2CORE IB
B2TRADER
B2CONNECT
B2TRANSLATE
B2BROKERClients
هذه الصفحة غير متوفرة باللغة العربية. يتم عرض النسخة الإنجليزية.
Get Clients
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
offset?integer
Sets the offset
Range
0 <= valueDefault
0sort_order?string
Sorts the items in ascending or descending order
Default
"desc"Value in
- "asc"
- "desc"
sort_by?string
Sorts the items by a specified value
Default
"createTime"Value in
- "createTime"
- "updateTime"
filter?unknown
Filters the items by a specified value
Header Parameters
accept-language?string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/clients?offset=0&sort_order=desc&sort_by=createTime" \ -H "accept-language: ja"{ "total": 0, "data": [ { "analytics": [ { "property": "umt", "value": "1111" } ], "clientId": 0, "accounts": [ { "accountId": 1, "accountNumber": "123123", "displayNumber": "123123", "createTime": "2022-01-01T00:00:00+00:00" } ], "birthday": "2022-01-01T00:00:00+00:00", "city": "string", "country": { "countryId": 8, "alpha2Code": "US", "alpha3Code": "USA", "countryName": "United States", "numericCode": "840" }, "company": { "fullName": "full name company", "shortName": "short name company" }, "email": "foo@bar.com", "internalType": "default", "firstName": "Mary", "lastName": "Smith", "middleName": "Jane", "name": "Mary Jane Smith", "nickname": "Voronov", "locale": "ja_JP", "manager": { "id": 0, "enabled": true, "email": "foo@bar.com", "name": "John Smith", "title": "mr.", "phone": "+995577755422", "resources": [ { "key": "caption", "locale": "ru_RU", "value": "Lorem" } ], "createTime": "2022-01-01T00:00:00+00:00" }, "phone": "+7 999 200 00 00", "riskLevel": "low", "status": "active", "tags": [ "string" ], "type": { "id": 0, "name": "Individual" }, "verificationLevel": { "id": 0, "name": "Level 1" }, "jurisdictionId": 1, "loggedAt": "2022-01-01T00:00:00+00:00", "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00", "limits": { "maxDemoTradingAccounts": 1, "maxLiveTradingAccounts": 1 }, "rights": [ { "name": "deposit", "isEnabled": true } ] } ]}{ "error": { "message": "Bad Request", "code": 0, "details": [ { "issue": "The selected value is invalid.", "field": "parameter" } ] }}{ "error": { "message": "Unauthorized" }}{ "error": { "message": "Forbidden" }}{ "error": { "message": "Too Many Requests" }}{ "error": { "message": "Service Unavailable" }}