Can not exec 'User List' query API

[timiil]

Description:

i am trying to query users with some simple condition, just like 'all active users'.

when i try to #1:

curl -H "X-Auth-Token: tz7L_ajNPk7KMbsdzmLP0prlGn_HNJ874pHJP7JCqIb" \
     -H "X-User-Id: oPn8LFLNaaZ3SokQP" \
     http://localhost:3380/api/v1/users.list

that is ok. no error, just return the full users list.

#2 shot:

curl -H "X-Auth-Token: tz7L_ajNPk7KMbsdzmLP0prlGn_HNJ874pHJP7JCqIb" \
>      -H "X-User-Id: oPn8LFLNaaZ3SokQP" \
>      http://localhost:3380/api/v1/users.list?query={active:true}
{
  "success": false,
  "error": "Invalid query parameter provided: \"active:true\" [error-invalid-query]",
  "errorType": "error-invalid-query"

#3 shot:

curl -H "X-Auth-Token: tz7L_ajNPk7KMbsdzmLP0prlGn_HNJ874pHJP7JCqIb" \
>      -H "X-User-Id: oPn8LFLNaaZ3SokQP" \
>      http://localhost:3380/api/v1/users.list?query='{active:true}'
{
  "success": false,
  "error": "Invalid query parameter provided: \"active:true\" [error-invalid-query]",
  "errorType": "error-invalid-query"

please let me know what is the correct manner about the query string, thanks very much!

Server Setup Information:

• Version of Rocket.Chat Server: 0.60.0-develop
• Operating System: debian
• Deployment Method(snap/docker/tar/etc): docker
• Number of Running Instances: 1
• DB Replicaset Oplog:
• Node Version: 8.8.1

[rusty-1-shaun]

Hi @timiil you need to use the --data-urlencode option to specify the query parameters as well as ensure that curl processes the request as a GET (-G). Here is an example of a curl query that works.

curl -s -G \
     -H "X-Auth-Token: ${TOKEN}" \
     -H "X-User-Id: ${USER_ID}" \
     -H "Accepts: application/json" \
     --data-urlencode 'fields={ "username":1, "status":1 }' \
     --data-urlencode 'query={"username":{"$regex":"us"}}' \
     https://myrocketchat.com/api/v1/users.list
{
  "users": [
    {
      "username": "peter",
      "status": "online",
      "_id": "xxxxxxWpdSgcYksN"
    },
    {
      "username": "justine",
      "status": "online",
      "_id": "xxxxxxa6xmZF3TNT2"
    },
    {
      "username": "rusty",
      "status": "online",
      "_id": "xxxxxxxL9Jit9wLy5r"
    },
    {
      "username": "susan",
      "status": "offline",
      "_id": "xxxxxxxQjCjfgPg9GN"
    },
    {
      "username": "brown",
      "status": "offline",
      "_id": "xxxxxxxxxsjiPjpAJ3"
    }
  ],
  "count": 5,
  "offset": 0,
  "total": 5,
  "success": true
}

[graywolf336]

Yes, the query param expects a valid json object to be passed.

[timiil]

@Rusty-1 , as your above code , your query condition is not effect. either online or offline has come ...

thanks for your reply

[mhow2]

On https://developer.rocket.chat/api/rest-api/query-and-fields-info, it's mentioned:

To only return the usernames for users, you would do something like this:
http://localhost:3000/api/v1/users.list?fields={ "username": 1 }

However, if you issue something like (with an Admin token):

curl -G -H "X-Auth-Token: xx" -H "X-User-Id: xx" --data-urlencode 'fields={"status":1}' https://myrc/api/v1/users.list

You'll get all the fields, not only status. @graywolf336 , @Rusty-1 could you clarify what is the expected behavior ?

Or is it something that relates with the word "all" in the sentence in https://developer.rocket.chat/api/rest-api/methods/users/list ?

Gets all of the users in the system and their information...