Get Admin of Room

Prev Next
Get
/api/v1/rooms.adminRooms.getRoom

Retrieves the admin of a room.

Permission required: view-room-administration

Changelog

Version Description
2.4.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
rid
stringRequired

The room ID.

Example654c9d1ca2f73c7460e1918b
Responses
200

OK

Success
{
  "_id": "ukFsHiySDhMkQyyyF",
  "name": "freightwave",
  "fname": "freightwave",
  "t": "p",
  "msgs": 4,
  "usersCount": 1,
  "u": {
    "_id": "Gd6iymRZBK4C6wqHN",
    "username": "bruno.raymundo"
  },
  "ro": false,
  "default": false,
  "success": true
}
Expand All
object
_id
string
name
string
fname
string
t
string
msgs
integer
usersCount
integer
u
object
_id
string
username
string
ro
boolean
default
boolean
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string