List Work Channels

GET

/work/channels

• Production
• QA

The channels this credential may read.

The cheap half of GET /work/room: membership only, no message or event history. Decided by room_visibility.visible_room — the same predicate the room read and the realtime socket run — so a channel can never be listed here and refused there.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

The channels this credential may read.

object

channels

Channels visible to the caller

Array<object>

One Work channel as the room stores it.

object

archivedAt

Any of:

string

string

null

null

createdAt

Any of:

string

string

null

null

createdBy

Any of:

string

string

null

null

description

Any of:

string

string

null

null

displayName

Any of:

string

string

null

null

id

Any of:

string

string

null

null

kind

Any of:

string

string

null

null

memberUserIds

Any of:

Array<string>

Array<string>

null

null

name

Any of:

string

string

null

null

participantAgentIds

Any of:

Array<string>

Array<string>

null

null

system

Any of:

boolean

boolean

null

null

visibility

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string