Get Channel Threads

Get channel threads. It supports the Offset, Count, and Sort Query Parameters along with Query and Fields Query Parameters.
URL
Requires Auth
HTTP Method
/api/v1/chat.getThreadsList
yes
GET
Payload
Argument
Example
Required
Description
rid
7aDSXtjMA3KPLxLjt
Required
The id of the channel.
Example Call
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
     -H "Content-type:application/json" \
4
     http://localhost:3000/api/v1/chat.getThreadsList?rid=GENERAL
Copied!
Example Result
1
{
2
    "threads": [
3
        {
4
            "_id": "gcGai9bRREqokjyPc",
5
            "rid": "GENERAL",
6
            "msg": "test",
7
            "ts": "2019-04-08T13:15:52.017Z",
8
            "u": {
9
                "_id": "p4a8YxvLQEHmiBKTS",
10
                "username": "marcos.defendi",
11
                "name": "Marcos Defendi"
12
            },
13
            "_updatedAt": "2019-04-08T14:40:27.789Z",
14
            "mentions": [],
15
            "channels": [],
16
            "replies": [
17
                "p4a8YxvLQEHmiBKTS"
18
            ],
19
            "tcount": 5,
20
            "tlm": "2019-04-08T14:40:27.724Z"
21
        },
22
        {
23
            "_id": "5iJjPNPhxMeLtEJQt",
24
            "rid": "GENERAL",
25
            "msg": "Sample message",
26
            "ts": "2019-04-07T20:41:15.965Z",
27
            "u": {
28
                "_id": "rocketchat.internal.admin.test",
29
                "username": "rocketchat.internal.admin.test",
30
                "name": "RocketChat Internal Admin Test"
31
            },
32
            "_updatedAt": "2019-04-08T13:41:55.205Z",
33
            "mentions": [],
34
            "channels": [],
35
            "replies": [
36
                "rocketchat.internal.admin.test",
37
                "p4a8YxvLQEHmiBKTS"
38
            ],
39
            "tcount": 1,
40
            "tlm": "2019-04-08T13:41:55.102Z"
41
        }
42
    ],
43
    "count": 2,
44
    "offset": 0,
45
    "total": 2,
46
    "success": true
47
}
Copied!
Change Log
Version
Description
1.0.0
Added

Get Message

Get Deleted Messages

Last modified 1yr ago

Export as PDF

Copy link

Edit on GitHub

Contents