Skip to main content
GET
List Slack channels

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Query Parameters

query
string

Narrow to rooms whose name matches. A leading # is ignored and case is folded. An exact match always comes first, then names that start with the text, then names that contain it. Omit it to list the whole workspace.

limit
integer

How many rooms to return. Defaults to 50, clamped at 200. A value that is not a positive integer is a 400.

Response

Success.

data
object[]
required

The page.

page
object
required

Present on every list, even when there is nothing more to fetch.