A method, that searches by users or channels on all users and channels available on server. It supports the Offset, Count, and Sort Query Parameters along with Query and Fields Query Parameters.
URL | Requires Auth | HTTP Method |
|
|
|
Argument | Example | Required | Description |
|
| Required | When |
curl -G -H "X-Auth-Token: ijFlJ1yfidXhwEYY284Anoq_iEsOeMMVCupzNhX22tB" \-H "X-User-Id: hw5DThnhQmxDWnavu" \-H "Content-type: application/json" \http://localhost:3000/api/v1/directory \--data-urlencode 'query={"text": "rocket", "type": "users", "workspace": "local"}'
{"result": [{"_id": "jRca8kibJx8NkLJxt","createdAt": "2018-04-13T12:46:26.517Z","emails": [{"address": "user.test.1523623548558@rocket.chat","verified": false}],"name": "EditedRealNameuser.test.1523623548558","username": "editedusernameuser.test.1523623548558","avatarETag": "6YbLtc4v9b4conXon"}],"count": 1,"offset": 0,"total": 1,"success": true}
curl -H "X-Auth-Token: ijFlJ1yfidXhwEYY284Anoq_iEsOeMMVCupzNhX22tB" \-H "X-User-Id: hw5DThnhQmxDWnavu" \-H "Content-type: application/json" \http://localhost:3000/api/v1/directory?query={"text": "gene", "type": "channels"}&count=1&offset=2
{"result": [{"_id": "GENERAL","ts": "2018-05-15T19:10:54.689Z","name": "general","usernames": ["rocketchat.internal.admin.test","editedusernameuser.test.1526941091574"]}],"count": 1,"offset": 2,"total": 4,"success": true}
Version | Description |
1.0.0 | Added |
0.65.0 | Added Pagination fields: |
0.64.0 | Added |