Skip to main content
GET
List channels

Authorizations

Authorization
string
header
required

Organization API key (modem_…).

Query Parameters

sourceName
string

Filter channels by source (e.g., slack, discord). Omit for all sources.

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Search channels by name. Omit when not searching.

Minimum string length: 1
ids
string<uuid>[]

Filter to specific channel IDs (e.g., to resolve names for a stored channel scope). Omit when not filtering by ID.

Required array length: 1 - 100 elements
connectedOnly
boolean

Only return channels whose backing integration is still connected. Currently filters GitHub repo channels to repositories with non-revoked access; other sources are unaffected. Omit to include all channels.

page
integer
default:1

The 1-based page number to return (default 1).

limit
integer
default:50

Maximum number of channels to return (default 50, max 100)

Required range: x <= 100

Response

OK

data
object[]
required
limit
integer
required

The page size used for this response.

page
integer
required

The 1-based page number returned.

totalCount
integer
required

Total number of items matching the query, across all pages.

Required range: x >= 0