GetChildrenAccounts

POST

https://api.voximplant.com/platform_api/GetChildrenAccounts

POST

/platform_api/GetChildrenAccounts

curl -X POST https://api.voximplant.com/platform_api/GetChildrenAccounts \
     -H "Authorization: Bearer <token>"

200Children accounts

{
  "result": [
    {
      "account_id": 414877,
      "account_name": "myparent-child-1",
      "account_email": "child-1@myparent.com",
      "api_key": "12345678-1234-1234-1234-aaaaaabbbbbb",
      "created": "2016-04-08 11:01:30",
      "language_code": "ru",
      "location": "Etc/GMT",
      "min_balance_to_notify": 68.5598,
      "account_notifications": false,
      "tariff_changing_notifications": false,
      "news_notifications": false,
      "active": true,
      "frozen": false,
      "balance": 0.4,
      "credit_limit": 0,
      "currency": "RUR",
      "support_robokassa": false,
      "support_bank_card": true,
      "support_invoice": true,
      "send_js_error": false,
      "a2p_sms_enabled": false,
      "fixed_balance": 0.4,
      "money_on_hold": 0,
      "allow_invoice": false,
      "is_bank_card_auto_charge_prohibited": false,
      "taxpayer_type": "default",
      "custom_pricing": false,
      "live_balance": 0.4
    },
    {
      "account_id": 464478,
      "account_name": "myparent-child-2",
      "account_email": "child-2@myparent.com",
      "api_key": "123aaa78-1234-1234-1234-aaa345567bbb",
      "created": "2016-04-11 06:09:45",
      "language_code": "ru",
      "location": "Etc/GMT",
      "min_balance_to_notify": 68.5598,
      "account_notifications": false,
      "tariff_changing_notifications": false,
      "news_notifications": false,
      "active": true,
      "frozen": false,
      "balance": 0,
      "credit_limit": 0,
      "currency": "RUR",
      "support_robokassa": false,
      "support_bank_card": true,
      "support_invoice": true,
      "send_js_error": false,
      "a2p_sms_enabled": false,
      "fixed_balance": 0,
      "money_on_hold": 0,
      "allow_invoice": false,
      "is_bank_card_auto_charge_prohibited": false,
      "taxpayer_type": "default",
      "custom_pricing": false,
      "live_balance": 0
    }
  ],
  "total_count": 530350,
  "count": 2
}

Gets the info about all children accounts.

Allowed roles: Owner.

Example request: Get the specified children.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

child_account_idlist of integersOptional

The account ID list separated by semicolons (;). You need to specify at least one of the following parameters: child_account_id, child_account_name, child_account_email

child_account_namestringOptional

The child account name to filter. You need to specify at least one of the following parameters: child_account_id, child_account_name, child_account_email

child_account_emailstringOptional

The child account email to filter. You need to specify at least one of the following parameters: child_account_id, child_account_name, child_account_email

activebooleanOptional

Whether the filter is active

frozenbooleanOptional

Whether the filter is frozen

ignore_invalid_accountsbooleanOptionalDefaults to false

Whether to ignore the invalid 'child_account_id' items

brief_outputbooleanOptionalDefaults to false

Whether to output the account_id only

medium_outputbooleanOptionalDefaults to false

Whether to output the account_id, account_name, account_email only

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

order_bystringOptionalDefaults to child_account_name

The following values are available: 'child_account_id', 'child_account_name' and 'child_account_email'

return_live_balancebooleanOptionalDefaults to true

Whether to get the user live balance

Response

Successful response

resultlist of objectsOptional

total_countintegerOptional

The total found user count

countintegerOptional

The returned user count