Documentation for version v73
Get accounts list
Description
Retrieves Altcraft service instance accounts list.
Request URL
Method: POST
https://example.com/api/v1.1/admin/accounts/list/
Request parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
| format | string | "json" | No | Response data format By default – json |
| from_id | int | 1 | No | The first account ID on the list By default –1 |
| limit | int | 100 | No | Accounts list limit By default – 1000 |
Request example
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"from_id": 300,
"limit": 10
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<from_id>300</from_id>
<limit>10</limit>
</xml>
Response example
- JSON
- XML
{
"data": [],
"error": 0,
"error_text": "Successful operation",
"total_count": 1
}
<xml>
<data/>
<error>0</error>
<error_text>Successful operation</error_text>
<total_count>1</total_count>
</xml>
Response parameters
| Parameter | Type | Description |
|---|---|---|
| error | int | Error code |
| error_text | string | Error text |
| id | int | Account ID |
| name | string | Account name |
| timezone | string | Account time zone |
| tariff_id | int | Account tariff ID |
| is_active | bool | Active account flag |
| pixels_enabled | bool | Enabled pixel flag |
| pushes_enabled | bool | Enabled push flag |
| is_smart | bool | Smart account flag |
| is_subscribers_suspend_all | bool | All subscribers suspended flag |
| is_tariff_exceed | bool | Tariff exceeded flag |