Support channels

List support channels

Changed on

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
get/support_channels

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/support_channels
  • Auth: HTTP bearer

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.

customer_user_idstring

Only return support channels opened by this customer.

participatedboolean

Set to true to only return channels the authenticated user has joined as a participant. Requires a user.

include_last_messageboolean

Set to true to return last_message and unread on each channel. Both are null otherwise, which keeps large lists fast.

include_participatedboolean

Set to true to return participated on each channel. It is null otherwise, which keeps large lists fast.

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": {
        "attachments": [
          {
            "content_type": "image/jpeg",
            "filename": "document.pdf"
          }
        ],
        "content": "Hey, are you available for a **quick call**?",
        "created_at": "2023-12-01T05:00:00.401Z"
      },
      "last_message_at": "2023-12-01T05:00:00.401Z",
      "resolved_at": "2023-12-01T05:00:00.401Z"
    }
  ]
}

Changes

  • 507636677fe9Revision changes
    • info

      added the new optional query request parameter customer_user_id

    • info

      added the new optional query request parameter include_last_message

    • info

      added the new optional query request parameter include_participated

    • info

      added the new optional query request parameter participated

    • info

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

    • info

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

    • info

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

    • info

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

  • 8473fa1d1f47Revision changes
    • info

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