Skip to main content
GET
/
channels
{
  "channels": [
    {
      "id": "<string>",
      "name": "<string>",
      "channel_type": "Public",
      "metadata": {},
      "is_archived": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "latest_message": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "content": "<string>",
        "channel_id": "<string>",
        "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sent_by": {
          "id": "<string>",
          "display_name": "<string>",
          "icon_url": "<string>",
          "role": "Admin",
          "metadata": {}
        },
        "read_by": [
          {
            "id": "<string>",
            "display_name": "<string>",
            "icon_url": "<string>",
            "role": "Admin",
            "metadata": {}
          }
        ],
        "reactions": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "emoji_code": "<string>",
            "user": {
              "id": "<string>",
              "display_name": "<string>",
              "icon_url": "<string>",
              "role": "Admin",
              "metadata": {}
            },
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "attachments": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "url": "<string>",
            "name": "<string>",
            "mime_type": "<string>",
            "size": 123,
            "source": "Binary",
            "metadata": {},
            "channel_id": "<string>"
          }
        ],
        "mentions": [
          {
            "type": "User",
            "user": {
              "id": "<string>",
              "display_name": "<string>",
              "icon_url": "<string>",
              "role": "Admin",
              "metadata": {}
            }
          }
        ],
        "thread_reply_info": {
          "count": 123,
          "last_replied_at": "2023-11-07T05:31:56Z"
        },
        "edited_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "metadata": {}
      },
      "unread_count": 123
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

ユーザーがログインすると発行されるsession_idをBearerトークンとして指定します

Query Parameters

name
string

チャンネル名で検索(部分一致)

channel_type
enum<string>

チャンネルタイプで検索

Available options:
Public,
Secret
include_archived
boolean
default:false

アーカイブ済みチャンネルを含めるかどうか(デフォルト: false)

include_unread_count
boolean
default:false

未読メッセージ数を含めるかどうか(デフォルト: false)

limit
integer
default:20

取得件数の上限(デフォルト: 20)

offset
integer
default:0

取得開始位置(デフォルト: 0)

Response

チャンネルリストを返却

channels
object[]
required

チャンネルの一覧

totalCount
integer
required

総件数