Skip to main content
GET
/
api
/
channels
/
{id}
curl -X GET "https://your-domain.com/api/channels/ch_abc123" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

{
  "id": "ch_abc123",
  "user_id": "user_123",
  "type": "group",
  "name": "Engineering Team",
  "description": "Team discussions",
  "is_private": true,
  "data": {},
  "meta": {},
  "access_grants": [],
  "user_ids": ["user_123", "user_456", "user_789"],
  "users": [
    {
      "id": "user_123",
      "name": "Alice",
      "is_active": true
    },
    {
      "id": "user_456",
      "name": "Bob",
      "is_active": false
    },
    {
      "id": "user_789",
      "name": "Charlie",
      "is_active": true
    }
  ],
  "is_manager": true,
  "write_access": true,
  "user_count": 3,
  "last_read_at": 1709567890123456789,
  "unread_count": 5,
  "created_at": 1709500000000000000,
  "updated_at": 1709567890123456789,
  "updated_by": "user_456"
}
Retrieves detailed information about a channel, including members, access control, and unread message counts.

​
Authentication

Requires a valid user session. User must have read access to the channel.

​
Path Parameters

​
id
string
required
The unique identifier of the channel

​
Response

Returns a detailed channel object with user information and metadata.
​
id
string
required
Unique channel identifier
​
user_id
string
required
ID of the user who created the channel
​
type
string
Channel type: standard, group, or dm
​
name
string
required
Channel name
​
description
string
Channel description
​
is_private
boolean
Whether the channel is private
​
data
object
Additional channel data
​
meta
object
Channel metadata
​
access_grants
array
Access control grants for the channel
​
user_ids
array
Array of member user IDs (for group/dm channels only)
​
users
array
Array of member user objects with activity status (for group/dm channels only)
​
is_manager
boolean
required
Whether the current user is a manager of this channel
​
write_access
boolean
required
Whether the current user has write access to this channel
​
user_count
integer
Total number of users with access to the channel
​
last_read_at
integer
Timestamp when the current user last read messages (epoch time in nanoseconds)
​
unread_count
integer
required
Number of unread messages for the current user
​
created_at
integer
required
Creation timestamp (epoch time in nanoseconds)
​
updated_at
integer
required
Last update timestamp (epoch time in nanoseconds)
​
updated_by
string
ID of user who last updated the channel
curl -X GET "https://your-domain.com/api/channels/ch_abc123" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

{
  "id": "ch_abc123",
  "user_id": "user_123",
  "type": "group",
  "name": "Engineering Team",
  "description": "Team discussions",
  "is_private": true,
  "data": {},
  "meta": {},
  "access_grants": [],
  "user_ids": ["user_123", "user_456", "user_789"],
  "users": [
    {
      "id": "user_123",
      "name": "Alice",
      "is_active": true
    },
    {
      "id": "user_456",
      "name": "Bob",
      "is_active": false
    },
    {
      "id": "user_789",
      "name": "Charlie",
      "is_active": true
    }
  ],
  "is_manager": true,
  "write_access": true,
  "user_count": 3,
  "last_read_at": 1709567890123456789,
  "unread_count": 5,
  "created_at": 1709500000000000000,
  "updated_at": 1709567890123456789,
  "updated_by": "user_456"
}

​
Notes

  • For group and dm channels, the response includes the user_ids and users arrays with member information
  • For standard channels, these fields are null and the user_count represents all users with read access
  • The is_manager field indicates if the current user can modify channel settings
  • The write_access field indicates if the current user can post messages
  • Admins always have full access to all channels