List support channels
Lists support channels between an account’s team and its customers, most recently active first by default. Pass open=true to find channels awaiting a support response.
Required permissions:
support_chat:read
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Query Parameters
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
Filter support channels by the authenticated user's role. Defaults to admin. When the caller is a company API key (no user), only admin-visible channels are returned.
all, admin, customer Whether to filter by open or resolved support channels. Set to true to only return channels awaiting a response, or false for resolved channels.
Only return support channels opened by this customer.
Only return support channels opened by any of these customers. Maximum 100 IDs per request.
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Set to true to only return channels the authenticated user has joined as a participant. Requires a user.
Set to true to return last_message and unread on each channel. Both are null otherwise, which keeps large lists fast.
Set to true to return participated on each channel. It is null otherwise, which keeps large lists fast.
The sort direction for the results. Use 'asc' for oldest first or 'desc' for newest first.
asc, desc The field to sort the support channels by, such as creation date or last message time.
created_at, last_post_sent_at The unique identifier of the company to list support channels for. Includes channels of child companies. When omitted, returns support channels across all companies the user has access to.
"biz_xxxxxxxxxxxxxx"

