Skip to main content
GET
/
dm_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 dmChannelListResponse of client.dmChannels.list()) {
  console.log(dmChannelListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "created_at": "123.45",
      "name": "Project Alpha Team",
      "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

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 | null

The unique identifier of a company to filter DM channels by. Only returns channels scoped to this company.

Example:

"biz_xxxxxxxxxxxxxx"

Response

A successful response

The connection type for DmsFeed.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.