Skip to main content
GET
List chat channels
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/chat/listChannels returns the factory, project and team channels your key or External App holds chat:read for at each channel’s home org unit (or an org unit above it), newest first. Direct messages, personal-assistant chats, group conversations and builder channels are never returned; a scope of direct, personal, group or system returns an empty page. scope and status apply together, and an unknown value is 400 bad_request. Pages are at most 50 rows; limit defaults to 50 and a larger value is 400 too_big. Follow meta.nextCursor while meta.hasMore is true; a page can be short or empty before the end. Each activeSessionCount reads at most 201 sessions and a page counts at most 1,000 sessions in total; meta.partial is true when a count on the page stopped at either bound, and that count is then a lower bound. See row visibility.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

scope
enum<string>
Available options:
factory,
project,
team,
direct,
personal,
group,
system
status
enum<string>
Available options:
ACTIVE,
ARCHIVED
limit
integer
default:50

Rows to read for this page, 1 to 50; a larger value is 400 too_big.

Required range: 1 <= x <= 50
cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1

Response

Channel page

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.