API

Get a channel

GET /v1/channels/{channelId}

Get a channel

Path parameters

  • channelId string Required

    The id of the channel

Responses

  • 200 application/json

    Channel found and returned successfully

    Hide response attributes Show response attributes object
    • id string Required

      The id of the channel.

    • name string Required

      The name of the channel.

    • emoji string

      The emoji of the channel

    • description object | null Required

      The description of the channel.

    • privacy string Required

      The privacy of the channel.

      Values are Private or Public.

    • autoJoin boolean Required

      Whether the channel will be auto-joined by new members.

    • readonly boolean Required

      Whether the channel will be in read-only for non admin.

    • showMembers boolean Required

      Whether the channel will show its members.
  • 400

    Malformed payload

  • 404

    Channel not found

GET /v1/channels/{channelId} 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/channels/{channelId}'
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "emoji": "string",
  "description": {},
  "privacy": "Private",
  "autoJoin": true,
  "readonly": true,
  "showMembers": true
}