List support channels

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const supportChannelListResponse of client.supportChannels.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(supportChannelListResponse.id);
}

{
  "data": [
    {
      "id": "<string>",
      "company_id": "<string>",
      "custom_name": "<string>",
      "customer_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "resolved_at": "2023-12-01T05:00:00.401Z",
      "last_message_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

support_channels

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const supportChannelListResponse of client.supportChannels.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(supportChannelListResponse.id);
}

{
  "data": [
    {
      "id": "<string>",
      "company_id": "<string>",
      "custom_name": "<string>",
      "customer_user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "resolved_at": "2023-12-01T05:00:00.401Z",
      "last_message_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Query Parameters

after

string | null

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

before

string | null

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

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

company_id

string

required

The ID of the company to list chat channels for

Example:

"biz_xxxxxxxxxxxxxx"

open

boolean | null

Filter for tickets where customer sent the last message (needs response) AND not resolved. Set to true to only return open channels, false to only return resolved channels.

direction

enum<string> | null

The direction to sort the channels by

Available options:

asc,

desc

order

enum<string> | null

The field to order the channels by

Available options:

created_at,

last_post_sent_at

Response

A successful response

The connection type for DmsFeed.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The unique identifier for the entity

data.company_id

string | null

required

The bot ID if this is a support chat

data.custom_name

string | null

required

The custom name of the DM channel, if any

data.customer_user

object

required

The customer user if this is a support chat

Show child attributes

data.customer_user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.customer_user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.customer_user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

data.resolved_at

string<date-time> | null

required

When the support ticket was resolved (null if unresolved)

Example:

"2023-12-01T05:00:00.401Z"

data.last_message_at

string<date-time> | null

required

When the last message was sent

Example:

"2023-12-01T05:00:00.401Z"

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Update chat channel Create support channel

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

List support channels

Authorizations

Query Parameters

Response