---
title: "Get Room Information"
slug: "get-room-information"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/get-room-information"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Room Information

Get/api/v1/rooms.info

Retrieves the information about the room.

### Changelog

| Version | Description |
| --- | --- |
| 0.72.0 | Added |

Header parametersX-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
X-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

Query parametersroomIdstring

The room ID. It is required if the `roomName` is not provided.

Exampledlpfuijw7ej
roomNamestring

The room name. It is required if the `roomId` is not provided.

Examplegeneral
fieldsstring

This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: `fields={ "username": 1 }`. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#query-and-fields) to learn more.

Responses200

OK

The response includes the following objects:

- `parent`: Represents the parent of a room. For discussions, this is the room where the discussion was created, identified by `prid`. For rooms inside a team, the parent will be the team's main room, identified by `team.roomId`. For other rooms, this property is undefined.
- `team`: Represents the team a room is part of. For rooms inside a team, this is the team identified by the `teamId` property. For everything else, this is undefined.

<select class='api-response-data' aria-label='Media type'><option value='17b9fce9-714f-49e6-94d0-f54aa4395cf7'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='5f0d5756-902b-49b2-a7ce-cd9c9ac13329'>Success</option>
</select>Success

```json
{
  "room": {
    "_id": "66ed2dba40141d95f32c292b",
    "fname": "new-channel",
    "_updatedAt": "2024-09-20T12:29:08.284Z",
    "customFields": {},
    "topic": "",
    "broadcast": false,
    "encrypted": false,
    "name": "new-channel",
    "t": "p",
    "msgs": 3,
    "usersCount": 2,
    "u": {
      "_id": "C38WSSzrGd2NCjzqJ",
      "username": "test.cat",
      "name": "test.cat"
    },
    "ts": "2024-09-20T08:09:30.417Z",
    "ro": false,
    "teamId": "66c82d78237405fc05fc1ef1",
    "default": false,
    "sysMes": true,
    "lastMessage": {
      "_id": "xZhJfE4rmaosjHZCe",
      "rid": "66ed2dba40141d95f32c292b",
      "msg": "testing",
      "alias": null,
      "ts": "2024-09-20T12:27:53.356Z",
      "u": {
        "_id": "C38WSSzrGd2NCjzqJ",
        "username": "test.cat",
        "name": "test.cat"
      },
      "_updatedAt": "2024-09-20T12:27:53.397Z",
      "urls": [],
      "mentions": [],
      "channels": [],
      "md": [
        {
          "type": "PARAGRAPH",
          "value": [
            {
              "type": "PLAIN_TEXT",
              "value": "testing"
            }
          ]
        }
      ]
    },
    "lm": "2024-09-20T12:27:53.356Z"
  },
  "team": {
    "_id": "66c82d78237405fc05fc1ef1",
    "name": "test-team",
    "type": 0,
    "roomId": "66c82d78237405fc05fc1eef"
  },
  "parent": {
    "_id": "66c82d78237405fc05fc1eef",
    "fname": "test-team",
    "name": "test-team",
    "t": "c"
  },
  "success": true
}
```

Expand Allobject  roomobject  _idstring    
tsstring    
tstring    
namestring    
usernames Array of object   object  
msgsinteger    
usersCountinteger    
_updatedAtstring    
uobject  _idstring    
usernamestring    
namestring    

defaultboolean    
lastMessageobject  _idstring    
tstring    
ridstring    
tsstring    
msgstring    
aliasstring   | null  
attachments Array of object   object  
fileobject  _idstring    
namestring    
typestring    

uobject  _idstring    
usernamestring    
namestring    

groupableboolean    
dridstring    
_updatedAtstring    

lmstring    

successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='a9caa0c4-b453-46f7-979f-4cbdaf60653d'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='d42f1a16-720b-43f9-b4b9-21969147eca8'>Example 1</option>
</select>Example 1

```json
{
  "success": false,
  "error": "The parameter \"roomId\" or \"roomName\" is required [error-roomid-param-not-provided]",
  "errorType": "error-roomid-param-not-provided"
}
```

object  successboolean    
errorstring    
errorTypestring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='c441dc47-e70b-469c-a8ee-1dc896aec79f'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f4966771-f2f1-41a2-ba76-c2aa61ea8eaa'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring