Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v74
  • v74
  • v73
  • v72
Login
  • Getting Started
  • Administrator documentation
  • Functional characteristics
  • Technology description
  • System requirements
  • Admin Panel
  • Platform installation
  • Platform configuration
  • Platform maintenance
  • Custom channels guide
  • Extra
  • Processing HTTP/HTTPS traffic
  • Administrator API
    • Accounts admin api
      • Restricted access
      • Get accounts list
      • Add a new account
      • Delete the account
    • Account users
    • Nodes
    • Senders admin api
    • Virtual senders
  • Administrator API
  • Accounts admin api
  • Get accounts list
Documentation for version v74

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​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format
By default – json
from_idint1NoThe first account ID on the list
By default –1
limitint100NoAccounts 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​

ParameterTypeDescription
errorintError code
error_textstringError text
idintAccount ID
namestringAccount name
timezonestringAccount time zone
tariff_idintAccount tariff ID
is_activeboolActive account flag
pixels_enabledboolEnabled pixel flag
pushes_enabledboolEnabled push flag
is_smartboolSmart account flag
is_subscribers_suspend_allboolAll subscribers suspended flag
is_tariff_exceedboolTariff exceeded flag
Last updated on Mar 16, 2024
Previous
Account Freeze and Unfreeze
Next
Add a new account
  • Description
  • Request URL
  • Request parameters
  • Request example
  • Response example
  • Response parameters
© 2015 - 2025 Altcraft, LLC. All rights reserved.