Get customer users
Getting customer users list for API requests
Method |
get.customer_users |
Description |
Getting a list of customer users for client area from under which requests to API are made. It is important to take into account whether or not a user has access rights. |
Who has access |
Partner |
Parameter of a request
Title |
Type |
Required |
Description |
access_token |
string |
yes |
Authentication session key |
limit |
number |
no |
Returning entries count. Refer to "Paging" |
offset |
number |
no |
Offset that defines from which number to return the entries "limit" . Default value is "0". Refer to "Paging" |
filter |
object |
no |
Refer to "Filters" |
fields |
array |
no |
Refer to "Viewing returning data" |
sort |
array |
no |
Refer to "Data sorting" |
Parameter of a reply
Title |
Type |
Filtering |
Sorting |
Description |
id |
number |
yes |
|
User unique ID Is used as user_id in all customer methods |
login |
string |
|
|
User login |
description |
string |
|
|
Description of a user |
name |
string |
yes |
yes |
User name |
customer_id |
number |
yes |
yes |
User unique ID |
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 reply structure
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"name":"string",
"description":"string",
"login":"string",
"customer_id":"number"
}
]
}
}
List of returning errors
Refer to the section "List of errors for the methods with the verb get"