Comment on page
Directory
A method, that searches by users or channels on all users and channels available on server. It supports the Pagination parameters, alongside the Query and Fields parameters.
URL | Requires Auth | HTTP Method |
|---|---|---|
/api/v1/directory | yes | GET |
Argument | Example | Required | Description |
|---|---|---|---|
query | {"text": "rocket", "type": "users", "workspace": "local"} | Required | When type is users you can send an additional workspace field, that can be local (default) or all. workspace=all will work only if Federation is enabled. |
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": "[email protected]",
"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 workspace query param |
0.65.0 | Added Pagination fields: count, total, offset |
0.64.0 | Added |
Last modified 3mo ago