Get a list of users

Description

Get a list of account users

Request URL

Method: POST

https://example.com/api/v1.1/admin/accounts/users/list

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format (By default – json)
account_id	int	9	Yes	Account ID
active	bool	true	No	Acticvate user
master	bool	false	No	Access to master settings
lang	string	RU	No	Language

Request example

JSON

{
    "token": "aabcdefghijklmnqrstuvwxyz",
    "format": "json",
    "account_id": 9,
    "active": true,
    "master": false,
    "lang": "RU"
}

XML

<xml>
    <token>aabcdefghijklmnqrstuvwxyz</token>
    <format>json</format>
    <account_id>9</account_id>
    <active>true</active>
    <master>false</master>
    <lang>RU</lang>
</xml>

Response example

JSON

{
    "data": [
        {
            "username": "example",
            "first_name": "Example",
            "last_name": "Example",
            "email": "example@gmail.com",
            "notify_email": "example@gmail.com",
            "phone": "",
            "lang": "RU",
            "active": true,
            "master": false
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 1
}

XML

<xml>
     <data>
        <user>
            <username>example</username>
            <first_name>Example</first_name>
            <last_name>Example</last_name>
            <email>example@gmail.com</email>
            <notify_email>example@gmail.com</notify_email>
            <phone></phone>
            <lang>RU</lang>
            <active>true</active>
            <master>false</master>
        </user>
    </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
username	string	User name to be used in the login
first_name	string	User name
last_name	string	User surname
email	string	User email
notify_email	string	User email for notifications
phone	string	Phone number
lang	string	language
active	bool	User activity status
master	bool	Access to master settings