Introduction
Developer
Ads
CRM
AI
Identity
Bounties
Engagement
Payins
Courses
Payouts
Stats
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()) {
console.log(supportChannelListResponse.id);
}{
"data": [
{
"id": "<string>",
"company_id": "<string>",
"custom_name": "Project Alpha Team",
"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
}
}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
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()) {
console.log(supportChannelListResponse.id);
}{
"data": [
{
"id": "<string>",
"company_id": "<string>",
"custom_name": "Project Alpha Team",
"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
}
}Documentation Index
Fetch the complete documentation index at: https://docs.whop.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
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.
"biz_xxxxxxxxxxxxxx"
Filter support channels by the authenticated user's role. Defaults to admin. When the caller is a company API key (no user), only admin-visible channels are returned.
all, admin, customer Whether to filter by open or resolved support channels. Set to true to only return channels awaiting a response, or false for resolved channels.
The sort direction for the results. Use 'asc' for oldest first or 'desc' for newest first.
asc, desc The field to sort the support channels by, such as creation date or last message time.
created_at, last_post_sent_at Was this page helpful?