Links
Comment on page

Groups Files

Retrieves the files from a private group. It supports the Pagination parameters, alongside the Query and Fields parameters.
URL
Requires Auth
HTTP Method
/api/v1/groups.files
yes
GET

Query Parameters

Argument
Example
Required
Description
roomId roomName
ByehQjC44FwMeiLbX test
Required
The room id. The room name.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/groups.files?roomId=ByehQjC44FwMeiLbX
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/groups.files?roomName=test

Example Result

{
"files": [
{
"_id": "S78TNnvaWGwdYRaCD",
"name": "images.jpeg",
"size": 9778,
"type": "image/jpeg",
"rid": "GENERAL",
"description": "",
"store": "GridFS:Uploads",
"complete": true,
"uploading": false,
"extension": "jpeg",
"progress": 1,
"user": {
"_id": "ksKsKmrjvxzkzxkww",
"username": "rocket.cat",
"name": "Rocket Cat"
},
"_updatedAt": "2018-03-08T14:47:37.003Z",
"instanceId": "uZG54xuoKauKHykbQ",
"etag": "jPaviS9qG22xC5sDC",
"path": "/ufs/GridFS:Uploads/S78TNnvaWGwdYRaCD/images.jpeg",
"token": "28cAb868d9",
"uploadedAt": "2018-03-08T14:47:37.295Z",
"url": "/ufs/GridFS:Uploads/S78TNnvaWGwdYRaCD/images.jpeg"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}

Change Log

Version
Description
0.64.0
Change userId to user object in response
0.59.0
Added
Last modified 5mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.