List User Rooms of a Team

Print
Dark
Light
PDF

List User Rooms of a Team

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/teams.listRoomsOfUser

Lists only the team's rooms the user has joined.

Permission required: view-all-team-channels

Header parameters

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

Query parameters

teamName

string

The team name. It is required if the teamId is not provided.

Examplelivestream

teamId

string

The team id. It is required if the teamName is not provided.

Example63f3efc4b000b6b6d86704b2

userId

stringRequired

The user id.

ExamplerbAXrutTFbNprfn

offset

integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.

Example50

count

integer

The number of items to return.

Example50

Responses

200

Success

{
  "rooms": [
    {
      "_id": "JKa7R9zu2DinBhBN9",
      "fname": "Livestream",
      "customFields": {},
      "description": "",
      "broadcast": false,
      "encrypted": false,
      "federated": false,
      "name": "Livestream",
      "t": "c",
      "msgs": 16,
      "usersCount": 4,
      "u": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "roxie"
      },
      "ts": "2023-02-22T17:15:26.989Z",
      "ro": false,
      "default": false,
      "sysMes": true,
      "_updatedAt": "2023-09-29T06:02:30.250Z",
      "lm": "2023-09-14T12:06:00.594Z",
      "lastMessage": {
        "_id": "rtf5JoPLQup3X7Aof",
        "t": "videoconf",
        "msg": "",
        "groupable": false,
        "blocks": [
          {
            "type": "video_conf",
            "blockId": "6502f728a2f73c7460df6f71",
            "callId": "6502f728a2f73c7460df6f71",
            "appId": "videoconf-core"
          }
        ],
        "ts": "2023-09-14T12:06:00.594Z",
        "u": {
          "_id": "rbAXPnMktTFbNpwtJ",
          "username": "test.test",
          "name": "test test"
        },
        "rid": "JKa7R9zu2DinBhBN9",
        "_updatedAt": "2023-09-14T12:06:00.685Z",
        "urls": [],
        "mentions": [],
        "channels": []
      },
      "teamId": "63f3efc4b000b6b6d86704b2",
      "teamDefault": true,
      "isLastOwner": true
    }
  ],
  "total": 1,
  "count": 1,
  "offset": 0,
  "success": true
}

Expand All

object

rooms

Array of object

object

_id

string

fname

string

customFields

object

description

string

broadcast

boolean

encrypted

boolean

federated

boolean

name

string

msgs

integer

usersCount

integer

object

_id

string

username

string

boolean

default

boolean

sysMes

boolean

_updatedAt

string

lastMessage

object

_id

string

msg

string

groupable

boolean

blocks

Array of object

object

type

string

blockId

string

callId

string

appId

string

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

teamId

string

teamDefault

boolean

isLastOwner

boolean

total

integer

count

integer

offset

integer

success

boolean

401

Unauthorized

Authorization Error

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

object

status

string

message

string

Was this article helpful?

What's Next

Directory