Get Channel Moderators

Print
Dark
Light
PDF

Get Channel Moderators

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/channels.moderators

List all the moderators in a channel.

Changelog

Version	Description
0.70.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

roomId

string

The room id. It is required if the roomName is not provided.

Exampledlpfuijw7ej

roomName

string

The room name. It is required if the roomId is not provided.

Examplegeneral

Responses

200

Success

{
  "moderators": [
    {
      "_id": "rocket.cat",
      "username": "rocket.cat",
      "name": "Rocket.Cat"
    }
  ],
  "success": true
}

Expand All

object

moderators

Array of object

object

_id

string

username

string

name

string

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

List Online Users in a Channel