Skip to main content
GET
/
chat_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 chatChannelListResponse of client.chatChannels.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(chatChannelListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "experience": {
        "id": "exp_xxxxxxxxxxxxxx",
        "name": "Trading Signals Chat"
      },
      "ban_media": true,
      "ban_urls": true,
      "who_can_post": "everyone",
      "who_can_react": "everyone",
      "user_posts_cooldown_seconds": 42,
      "banned_words": [
        "<string>"
      ]
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

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 unique identifier of the company to list chat channels for.

Example:

"biz_xxxxxxxxxxxxxx"

​
product_id
string | null

The unique identifier of a product to filter by. When set, only chat channels connected to this product are returned.

Example:

"prod_xxxxxxxxxxxxx"

Response

A successful response

The connection type for ChatFeed.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.