Skip to main content
GET
List Channels

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

dms:read
chat:read
support_chat:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Queryparameters

first
integer
standaard:20

Number of results to return from the start of the range.

Vereist bereik: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Vereist bereik: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

kind
enum<string>[]
vereist

Channel kinds to return. Combine private and support, or pass community alone. private includes one-to-one and group direct messages.

Beschikbare opties:
private,
community,
support
support_role
enum<string>
standaard:customer

Which support channels to return. customer returns support chats you opened, including when account_id is set. staff returns the support inbox of the account in account_id, and requires permission to read that account's support chats. Applies only to support channels.

Beschikbare opties:
customer,
staff
account_id
string

Filter channels by their owning account, prefixed biz_. Applies to private, community and support channels.

query
string

Return only channels whose name contains this text. Private and support channels also match a member's username or name. % and _ match literally.

status
enum<string>

Return only support channels with this resolution. Requires kind to be support alone.

Beschikbare opties:
unresolved,
resolved
awaiting_reply
boolean

true returns unresolved support channels whose last message came from the customer; false returns the other support channels. Other channel kinds are returned either way.

unread
boolean

true returns channels with messages you have not read; false returns the rest. Requires authenticating as a user.

pinned
boolean

true returns private and support channels you have pinned; false returns those you have not. Requires authenticating as a user.

viewed
boolean

true returns community channels you have opened; false returns those you never have. Requires authenticating as a user.

requested
boolean

true returns your pending direct-message requests; false returns your accepted private channels. Requires private in kind and authenticating as a user. With support also in kind, false keeps support channels and true returns only pending requests.

order
enum<string>

The field to sort by. Defaults to last_viewed_at for community channels and last_message_at for private and support channels. Ties sort in a stable order. Cannot be supplied with updated_after.

Beschikbare opties:
created_at,
last_message_at,
last_viewed_at
include_members
boolean

Include the current members of private and support channels, including you, with their public profiles.

include_last_message
boolean

Include the most recent message you can see, with its author.

direction
enum<string>

The sort direction. Defaults to desc. Cannot be supplied with updated_after.

Beschikbare opties:
asc,
desc
include_deleted
boolean
standaard:false

Include redacted entries for deleted channels and your removed memberships. Use deleted_at to remove these channels from your cache.

updated_after
string

Return channels where the channel or your membership changed at or after this ISO 8601 timestamp. Cannot be more than one hour old, including on subsequent pages. For older changes, reload channels without updated_after. Results use ascending synchronized_at order. Cannot be combined with order, direction, query, status, awaiting_reply, unread, pinned, viewed, requested, created_before, or created_after.

created_before
string

Return only channels created before this ISO 8601 timestamp.

created_after
string

Return only channels created after this ISO 8601 timestamp.

Respons

operation completed

data
object[]
vereist
page_info
object
vereist