API

List channels

GET /v1/channels

List channels

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

Responses

  • 200 application/json

    Channels returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items 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.

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

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