get-room-information.md

Get Room Information

Retrieves the information about a specific room.

HTTP Method	URL	Requires Auth
GET	/api/v1/rooms.info	yes

Query Parameters

This endpoint supports only the field parameter for#query-and-fields. Additional parameters are as follows:

Key	Example Value	Description
roomId* or roomName*	ByehQjC44FwMeiLbX or general	The room ID or name. You must enter at least one of the parameters.

Example Call

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

Example Response

{
  "room": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "testing",
    "fname": "testing",
    "t": "c",
    "msgs": 0,
    "usersCount": 2,
    "u": {
      "_id": "HKKPmF8rZh45GMHWH",
      "username": "marcos.defendi"
    },
    "customFields": {},
    "broadcast": false,
    "encrypted": false,
    "ts": "2020-05-21T13:14:07.070Z",
    "ro": false,
    "default": false,
    "sysMes": true,
    "_updatedAt": "2020-05-21T13:14:07.096Z"
  },
  "success": true
}

Change Log

Version	Description
0.72.0	Added