Get Channel Information
    • Dark
      Light
    • PDF

    Get Channel Information

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/channels.info

    Retrieves the information about the channel. This does not include archived channels.

    Changelog

    VersionDescription
    0.48.0Added
    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

    OK

    Example
    {
      "channel": {
        "_id": "ByehQjC44FwMeiLbX",
        "name": "testing",
        "fname": "testing",
        "t": "c",
        "msgs": 0,
        "usersCount": 2,
        "u": {
          "_id": "HKKPmF8rZh45GMHWH",
          "username": "marcos.defendi"
        },
        "customFields": {},
        "broadcast": false,
        "encrypted": false,
        "ts": "2020-05-21T13:14:07.070Z",
        "ro": false,
        "default": false,
        "sysMes": true,
        "_updatedAt": "2020-05-21T13:14:07.096Z"
      },
      "success": true
    }
    Expand All
    object
    channel
    object
    _id
    string
    fname
    string
    customFields
    object
    topic
    string
    broadcast
    boolean
    encrypted
    boolean
    name
    string
    t
    string
    msgs
    integer
    usersCount
    integer
    u
    object
    _id
    string
    username
    string
    ts
    string
    ro
    boolean
    default
    boolean
    sysMes
    boolean
    _updatedAt
    string
    lastMessage
    object
    _id
    string
    rid
    string
    msg
    string
    ts
    string
    u
    object
    _id
    string
    username
    string
    name
    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
    success
    boolean

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.