Get Rooms
- Print
- DarkLight
- PDF
Get Rooms
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/rooms.get
Get all opened rooms (all joined public & private channels and all DMs) of the authenticated user.
Changelog
Version | Description |
---|---|
0.72.0 | Added |
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
updatedSince
string
A date as an ISO string. When you provide the updatedSince
query parameter, then the update and remove in the response will contain only those updated and removed since the specified date and time.
Example2017-11-25T15:08:17.248Z
Responses
200
OK
Example 1
{
"update": [
{
"_id": "5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ",
"t": "d",
"usernames": [
"roxie",
"test.test"
],
"usersCount": 2,
"msgs": 5,
"ts": "2023-07-11T01:37:04.552Z",
"uids": [
"5fRTXMt7DMJbpPJfh",
"rbAXPnMktTFbNpwtJ"
],
"encrypted": true,
"default": false,
"ro": false,
"sysMes": true,
"_updatedAt": "2023-09-16T09:43:42.853Z",
"e2eKeyId": "eyJhbGciOiJB",
"lastMessage": {
"_id": "vMkTMrSESTfrLenyv",
"t": "videoconf",
"msg": "",
"groupable": false,
"blocks": [
{
"type": "video_conf",
"blockId": "650318e4a2f73c7460df7d0b",
"callId": "650318e4a2f73c7460df7d0b",
"appId": "videoconf-core"
}
],
"ts": "2023-09-14T14:29:56.295Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test",
"name": "test test"
},
"rid": "5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ",
"_updatedAt": "2023-09-14T14:29:56.340Z",
"urls": [],
"mentions": [],
"channels": []
},
"lm": "2023-09-14T14:29:56.295Z"
},
{
"_id": "bfeqKDqQRxYM2tGXz",
"fname": "Testing-Teams-Bridge",
"customFields": {},
"topic": "",
"broadcast": false,
"encrypted": false,
"name": "Testing-Teams-Bridge",
"t": "p",
"msgs": 1,
"usersCount": 1,
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
},
"ts": "2023-03-09T18:20:33.353Z",
"ro": false,
"default": false,
"sysMes": true,
"_updatedAt": "2023-09-16T09:43:42.870Z",
"lastMessage": {
"rid": "bfeqKDqQRxYM2tGXz",
"ts": "2023-03-13T00:03:07.799Z",
"file": {
"_id": "DuGKthdwSZibkB92D",
"name": "Clipboard - March 13, 2023 1:03 AM.png",
"type": "image/png"
},
"files": [
{
"_id": "DuGKthdwSZibkB92D",
"name": "Clipboard - March 13, 2023 1:03 AM.png",
"type": "image/png"
},
{
"_id": "mKF2t96heAkz7Wbm3",
"name": "Clipboard - March 13, 2023 1:03 AM.png",
"type": "image/png"
}
],
"attachments": [
{
"ts": "1970-01-01",
"title": "Clipboard - March 13, 2023 1:03 AM.png",
"title_link": "/file-upload/DuGKthdwSZibkB92D/Clipboard%20-%20March%2013,%202023%201:03%20AM.png",
"title_link_download": true,
"image_dimensions": {
"width": 480,
"height": 245
},
"image_preview": "/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQ==",
"image_url": "/file-upload/mKF2t96heAkz7Wbm3/Clipboard%20-%20March%2013,%202023%201:03%20AM.png",
"image_type": "image/png",
"image_size": 206457,
"type": "file"
}
],
"msg": "",
"groupable": false,
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test",
"name": "test test"
},
"_id": "yGEPxxKAfJzt96M6a",
"_updatedAt": "2023-03-13T00:03:07.876Z",
"urls": [],
"mentions": [],
"channels": []
},
"lm": "2023-03-13T00:03:07.799Z"
},
{
"_id": "G8KgwWSRLua9bZETT",
"fname": "Omnichannel Instagram Setup",
"customFields": {},
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
},
"default": false,
"sysMes": true,
"msgs": 11,
"ts": "2023-03-30T15:57:52.680Z",
"_updatedAt": "2023-09-16T09:43:42.870Z",
"name": "omnichannel-instagram-setup",
"t": "p",
"usersCount": 1,
"ro": false,
"lastMessage": {
"_id": "gz3syD8NYXF8gvgNg",
"rid": "G8KgwWSRLua9bZETT",
"u": {
"_id": "J7oi3eBcRYFRnb8x3",
"username": "instagram.bot",
"name": "Instagram Direct"
},
"msg": "Any existing authentication between Rocket.Chat and Instagram has been revoked by @test.test. As a result, no new messages can be sent out nor will any be received. If this is a mistake, please run `/instagram authorize` command to reauthorize.",
"ts": "2023-05-30T12:01:42.438Z",
"_updatedAt": "2023-05-30T12:01:42.612Z",
"groupable": false,
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "Any existing authentication between "
},
{
"type": "LINK",
"value": {
"src": {
"type": "PLAIN_TEXT",
"value": "//Rocket.Chat"
},
"label": [
{
"type": "PLAIN_TEXT",
"value": "Rocket.Chat"
}
]
}
},
{
"type": "PLAIN_TEXT",
"value": " and Instagram has been revoked by "
},
{
"type": "MENTION_USER",
"value": {
"type": "PLAIN_TEXT",
"value": "test.test."
}
},
{
"type": "PLAIN_TEXT",
"value": " As a result, no new messages can be sent out nor will any be received. If this is a mistake, please run "
},
{
"type": "INLINE_CODE",
"value": {
"type": "PLAIN_TEXT",
"value": "/instagram authorize"
}
},
{
"type": "PLAIN_TEXT",
"value": " command to reauthorize."
}
]
}
]
},
"lm": "2023-05-30T12:01:42.438Z"
},
{
"_id": "6514d34ea2f73c7460e18cb4",
"fname": "test-discussion",
"_updatedAt": "2023-09-28T01:14:04.275Z",
"topic": "general",
"prid": "GENERAL",
"encrypted": false,
"name": "M75nSgA3uYsnTbKRu",
"t": "c",
"msgs": 1,
"usersCount": 1,
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"ts": "2023-09-28T01:13:50.574Z",
"ro": false,
"default": false,
"sysMes": true,
"lastMessage": {
"_id": "pnm4kh84HfncDEZj7",
"rid": "6514d34ea2f73c7460e18cb4",
"msg": "Hi guys , this is for SWE team",
"ts": "2023-09-28T01:14:04.119Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"_updatedAt": "2023-09-28T01:14:04.233Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "Hi guys , this is for SWE team"
}
]
}
]
},
"lm": "2023-09-28T01:14:04.119Z"
}
],
"remove": [
{
"_id": "6512153aa2f73c7460e18c5e",
"_deletedAt": "2023-09-26T00:29:17.723Z"
}
],
"success": true
}
object
update
Array of object
object
_id
string
t
string
usernames
Array of string
string
usersCount
integer
msgs
integer
ts
string
uids
Array of string
string
encrypted
boolean
default
boolean
ro
boolean
sysMes
boolean
_updatedAt
string
e2eKeyId
string
lastMessage
object
_id
string
t
string
msg
string
groupable
boolean
blocks
Array of object
object
type
string
blockId
string
callId
string
appId
string
ts
string
u
object
_id
string
username
string
name
string
rid
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
lm
string
fname
string
customFields
object
u
object
_id
string
username
string
name
string
name
string
topic
string
prid
string
remove
Array of object
object
_id
string
_deletedAt
string
success
boolean
Was this article helpful?