Get Users List
Gets all of the users in the system and their information, the result is only limited to what the request sender has access to view.
Query Parameters
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/users.list
Example Response
If the request sender is a regular user:
{
"users": [
{
"_id": "nSYqWzZ4GsKTX4dyK",
"type": "user",
"status": "offline",
"active": true,
"name": "Example User",
"utcOffset": 0,
"username": "example"
},
{
...
}
],
"count": 10,
"offset": 0,
"total": 10,
"success": true
}
If the request sender is an admin:
{
"users": [
{
"_id": "Bm9YcfBCrwSTSGof7",
"username": "botkit.user",
"emails": [
{
"address": "botkit@user.cm",
"verified": false
}
],
"status": "offline",
"active": true,
"roles": [
"bot"
],
"name": "Botkit User",
"nameInsensitive": "botkit user"
},
{
"_id": "Fdh2KgsB7dtwbYrNw",
"username": "john.m",
"emails": [
{
"address": "john@m.com",
"verified": true
}
],
"status": "offline",
"active": true,
"roles": [
"user"
],
"name": "John M",
"nameInsensitive": "john m"
},
{...},
{
"_id": "jowYXPgJoKaoxzz4q",
"username": "user.one",
"emails": [
{
"address": "remego8086@d3ff.com",
"verified": false
}
],
"status": "offline",
"active": true,
"roles": [
"livechat-manager",
"livechat-agent"
],
"name": "User One",
"nameInsensitive": "user one"
}
],
"count": 11,
"offset": 0,
"total": 11,
"success": true
}
Change Log
Last updated