Get Room Images

Print
Dark
Light
PDF

Get Room Images

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/rooms.images

Retrieves the images of a room that you are a member of.

Header parameters

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Query parameters

roomId

stringRequired

The room ID.

Example654c9d1ca2f73c7460e1918b

startingFromId

string

Filter images using the file ID.

Example666fdecb4ac1a8e6404ededd

offset

integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.

Example50

count

integer

The number of items to return.

Example50

Responses

200

Success

{
  "files": [
    {
      "_id": "666fdecb4ac1a8e6404ededd",
      "name": "oauth-screen.png",
      "size": 78441,
      "type": "image/png",
      "rid": "6630e42b72f069422b1022c1",
      "userId": "yuT9xp9eEd6HqB3n8",
      "store": "GridFS:Uploads",
      "_updatedAt": "2024-06-17T06:59:23.608Z",
      "identify": {
        "format": "png",
        "size": {
          "width": 1580,
          "height": 884
        }
      },
      "complete": true,
      "etag": "yvaG9cjz6YRRdMg4L",
      "path": "/ufs/GridFS:Uploads/666fdecb4ac1a8e6404ededd/oauth-screen.png",
      "progress": 1,
      "token": "1888eA0A0B",
      "uploadedAt": "2024-06-17T06:59:23.602Z",
      "uploading": false,
      "url": "https://pro.writing-demo.dev.rocket.chat/ufs/GridFS:Uploads/666fdecb4ac1a8e6404ededd/oauth-screen.png",
      "typeGroup": "image"
    },
    {
      "_id": "666fddea4ac1a8e6404eded7",
      "name": "11.jpg",
      "size": 83832,
      "type": "image/jpeg",
      "rid": "6630e42b72f069422b1022c1",
      "userId": "yuT9xp9eEd6HqB3n8",
      "store": "GridFS:Uploads",
      "_updatedAt": "2024-06-17T06:55:38.044Z",
      "identify": {
        "format": "jpeg",
        "size": {
          "width": 839,
          "height": 932
        }
      },
      "complete": true,
      "etag": "3jZf7SJZFCPpf9JK8",
      "path": "/ufs/GridFS:Uploads/666fddea4ac1a8e6404eded7/11.jpg",
      "progress": 1,
      "token": "498bb849C8",
      "uploadedAt": "2024-06-17T06:55:38.029Z",
      "uploading": false,
      "url": "https://pro.writing-demo.dev.rocket.chat/ufs/GridFS:Uploads/666fddea4ac1a8e6404eded7/11.jpg",
      "typeGroup": "image"
    }
  ],
  "count": 50,
  "offset": 0,
  "total": 2,
  "success": true
}

Expand All

object

files

Array of object

object

_id

string

name

string

size

integer

type

string

rid

string

userId

string

store

string

_updatedAt

string

identify

object

format

string

size

object

width

integer

height

integer

complete

boolean

etag

string

path

string

progress

integer

token

string

uploadedAt

string

uploading

boolean

url

string

typeGroup

string

count

integer

offset

integer

total

integer

success

boolean

400

Bad Request

Invalid Params

{
  "success": false,
  "error": "must have required property 'roomId' [invalid-params]",
  "errorType": "invalid-params"
}

object

success

boolean

error

string

errorType

string

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string

Was this article helpful?

What's Next

Audit Rooms