Sign in
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
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

account_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

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"
    }
  ]
}

Changes

Changed in 3 of the 74 revisions of this API.4113

  • 8473fa1d1f471See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

  • 697924df40d1112See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    • ○

      added the new optional query request parameter account_id

      new-optional-request-parameter

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f67a043e3190310See the full diff
    • ▲

      the query request parameter direction was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      the query request parameter order was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      the query request parameter view was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value admin to the query request parameter view

      request-parameter-enum-value-added

    • ○

      added the new enum value all to the query request parameter view

      request-parameter-enum-value-added

    • ○

      added the new enum value asc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value created_at to the query request parameter order

      request-parameter-enum-value-added

    • ○

      added the new enum value customer to the query request parameter view

      request-parameter-enum-value-added

    • ○

      added the new enum value desc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value last_post_sent_at to the query request parameter order

      request-parameter-enum-value-added

    • ○

      for the query request parameter direction, the type was generalized from no type to string

      request-parameter-type-generalized

    • ○

      for the query request parameter order, the type was generalized from no type to string

      request-parameter-type-generalized

    • ○

      for the query request parameter view, the type was generalized from no type to string

      request-parameter-type-generalized

Of the 74 revisions, 1 has no diff computed.