Get Rooms

Get all rooms a user belongs to.

Payload Parameters

Argument

Example

Required

Description

date

{ "$date": 1480377601 }

Required

A timestamp with the latest client update time in order to just send what changed since last call. If it's the first time calling, send a 0 as date.

Example call

{
    "msg": "method",
    "method": "rooms/get",
    "id": "42",
    "params": [ { "$date": 1480377601 } ]
}

Example Response

The result is an object with two fields: update and remove.

Remove field

The remove field is a collection of room id identifying the rooms that were removed from the server.

Update field

The update field is a collection of room and its content varies according to the room type.

{
    "msg": "result",
    "id": "42",
    "result": {
        "update": [
            ... // rooms
        ],
        "remove": [
            ... // room ids
        ]
    }
}

Last updated

Rocket.Chat versions receive support for six months after release.