List channels

v1.0.0

List channels the requester can access, sorted by name and ID. Includes public channels, their personal #me channel, and private channels they belong to. Call provision_defaults to create missing default channels. Send limit and offset to get a page with count, next, previous, and results. Without limit, the response is an array of all accessible channels.

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "project_id": {
      "type": "string"
    }
  },
  "required": [
    "project_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "count",
    "results"
  ],
  "properties": {
    "count": {
      "type": "integer"
    },
    "next": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "previous": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Response shape for a task channel, read from a frozen ``ChannelDTO``.",
        "required": [
          "auto_archive_after_days",
          "channel_type",
          "created_at",
          "github_integration",
          "id",
          "name",
          "repositories",
          "system_role"
        ],
        "properties": {
          "auto_archive_after_days": {
            "type": [
              "integer",
              "null"
            ]
          },
          "channel_type": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "created_by": {
            "type": "object"
          },
          "github_integration": {
            "type": [
              "integer",
              "null"
            ]
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "repositories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "starred": {
            "type": "boolean"
          },
          "system_role": {
            "description": "Identifies this channel as one of the two system-provisioned spaces ('personal' for the user's own #me space, 'general' for the team's shared #general space). Null for an ordinary channel.\n\n* `personal` - Personal\n* `general` - General",
            "type": "object"
          }
        }
      }
    }
  }
}