Getting the list of users of the customer's client area from which API requests can be made. Note that the user's access rights apply.

Getting the list of users of the customer's client area from which API requests can be made. Note that the user's access rights apply

Method	get.customer_users
Description	Getting the list of users of the customer's client area from which API requests can be made. Note that the user's access rights apply.
Available to	Partner

Request parameters

Name	Type	Required	Description
access_token	string	yes	Authentication session key
limit	number	no	Number of records returned. See section "Paging"
offset	number	no	Offset defining the record number from which to return "limit" records. The default is "0". See section "Paging"
filter	object	no	See section "Filtering criteria"
fields	array	no	See section "Viewing returned data"
sort	array	no	See section "Sorting data"

Response parameters

Name	Type	Filtering	Sorting	Description
id	number	yes		Unique user identifier. Used as user_id in all customer methods.
login	string			User login
description	string			User description
name	string	yes	yes	User name
customer_id	number	yes	yes	Unique customer identifier

JSON request structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "get.customer_users",
    "params": {
        "access_token": "string",
        "offset": "number",
        "limit": "number",
        "filter": {},
        "sort": [
            { "field": "string", "order": "string" }
        ],
        "fields": [ "string" ]
    }
}

JSON response structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            {
                "id": "number",
                "name": "string",
                "description": "string",
                "login": "string",
                "customer_id": "number"
            }
        ]
    }
}

List of returned errors

See the section "List of errors for methods with the get method".