Skip to main content
GET
/
messages
JavaScript
import Whopsdk from 'whopsdk';

const client = new Whopsdk({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const messageListResponse of client.messages.list({ channel_id: 'channel_id' })) {
  console.log(messageListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "content": "<string>",
      "poll": {
        "options": [
          {
            "id": "<string>",
            "text": "<string>"
          }
        ]
      },
      "replying_to_message_id": "<string>",
      "is_edited": true,
      "is_pinned": true,
      "message_type": "regular",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "username": "<string>",
        "name": "<string>"
      },
      "view_count": 42,
      "reaction_counts": [
        {
          "emoji": "<string>",
          "count": 42
        }
      ],
      "poll_votes": [
        {
          "option_id": "<string>",
          "count": 42
        }
      ]
    }
  ],
  "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

channel_id
string
required

The ID of the channel or the experience ID to list messages for

Response

A successful response

The connection type for DmsPost.

data
array | null
required

A list of nodes.

page_info
object
required

Information to aid in pagination.

I