Sign in
latestOpenAPI 3.1.02026-08-203914235.9 MB

6a23760847c8

Support channels

List support channels

Returns a paginated list of support channels for a specific company, with optional filtering by resolution status and custom sorting.

Required permissions:

  • support_chat:read
get/support_channels

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
company_idstring

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.

Example:biz_xxxxxxxxxxxxxx
view'all' | 'admin' | 'customer'

The perspective to filter support channels by.

openboolean

Whether to filter by open or resolved support channels. Set to true to only return channels awaiting a response, or false for resolved channels.

direction'asc' | 'desc'

The direction of the sort.

order'created_at' | 'last_post_sent_at'

Sort options for message channels

Response

A successful response

Example response

{
  "data": [
    {
      "custom_name": "Project Alpha Team",
      "customer_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "last_message_at": "2023-12-01T05:00:00.401Z",
      "resolved_at": "2023-12-01T05:00:00.401Z"
    }
  ]
}