Account users list

This API allows you to retrieve a list of users for a specific account with basic information for each user.

How to get data

Method

GET

Request address

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

Request parameters

  • cmd=users — command to get the list of users
  • node — the number of the node where the command should be executed
     

Example request

https://<server_address>/api/api.php?cmd=users&node=1
Response
{
  "code": 0,
  "data": [
    {
      "id": 123,
      "email": "qwqw@skyelectronics.ru",
      "information": "qwqw",
      "language": "en",
      "login": "qwqw@skyelectronics.ru",
      "name": "qwqw",
      "password": "xxxxxxxxx",
      "roleid": 0
    },
    {
      "id": 212,
      "email": "vd@skyelectronics.ru",
      "information": "test",
      "language": "ru",
      "login": "vd",
      "name": "Vitaliy",
      "password": "xxxxxxx",
      "roleid": 0
    }
  ],
  "message": "OK"
}
In response to the API request, the following is returned:
  • code — request result code (0 = successful)
  • data — array of user objects:
  • identifier — unique user ID
  • email — user’s email address
  • information — additional information about the user
  • language — user interface language (en = English, ru = Russian)
  • login — user login for signing in
  • name— user’s name
  • password — user’s password (partially hidden in the response)
  • roleid — user role (0 = regular user, 1 = administrator, etc.)
  • message — text message with the result of the request