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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
channel_id
string
required

取得対象となるチャンネルのID

Required string length: 1 - 100

Response

チャンネル詳細を返却

チャンネル詳細

​
name
string
required

チャンネル名

Required string length: 1 - 200
​
channel_type
enum<string>
required

公開チャンネルか秘密チャンネルか

Available options:
Public,
Secret
​
is_archived
boolean
required

アーカイブ済みかどうか

​
created_at
string<date-time>
required

作成日時

​
updated_at
string<date-time>
required

更新日時

​
id
string

チャンネルID

Required string length: 1 - 100
​
metadata
object

任意の追加メタデータ

​
latest_message
object

チャンネル内の最新メッセージ

​
unread_count
integer<int32>

チャンネル内の未読メッセージ数