×

Accounts list

This API retrieves the list of accounts with basic information: contract ID, name, balance, and the number of vehicles.

How to get data

Method

GET

Request address

To get the data, use the address: https://<server_address>/backend/api.php?

Request parameters

  • cmd=accountslist— command to retrieve the list of accounts
  • node — the number of the node where the command should be executed
     

Example request

https://<server_address>/backend/api.php?cmd=accountslist&node=1
Response
{
  "id": 1003,
  "org_name": "software_testing",
  "org_type": 1,
  "balance": "0.00",
  "acc_deposit": "0.00",
  "comment": null,
  "inn": "1",
  "kpp": "1",
  "bill_email": "102.ru",
  "bill_phone": "1",
  "veh_count": 13
}
In response to the API request, the following is returned:
  • id — unique account identifier
  • org_name — organization or contract name
  • org_type — type of organization
  • balance — current contract balance
  • acc_deposit — deposit amount on the contract
  • comment — additional comment for the contract
  • inn — tax identification number (TIN) of the organization
  • kpp — tax registration reason code (if applicable)
  • bill_email — email address for billing or invoicing notifications
  • bill_phone — contact phone number for billing inquiries
  • veh_count — number of vehicles linked to the account