Messages

List messages

Changed on

Lists messages in an experience chat, DM, or group chat channel, sorted by creation time.

Required permissions (one of):

  • chat:read
  • dms:read
  • support_chat:read
get/messages

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/messages
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

afterstring

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
channel_idstring required

The unique identifier of the channel or experience to list messages for.

direction'asc' | 'desc'

The direction of the sort.

Response

A successful response

Example response

{
  "data": [
    {
      "content": "Hey, are you available for a **quick call**?",
      "created_at": "2023-12-01T05:00:00.401Z",
      "poll_votes": [
        {
          "count": 42
        }
      ],
      "reaction_counts": [
        {
          "count": 42
        }
      ],
      "updated_at": "2023-12-01T05:00:00.401Z",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "view_count": 42
    }
  ]
}

Changes

  • 0845dd4950f9Revision changes
    • info

      the security scope chat:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope support_chat:read was removed from the endpoint's security scheme bearerAuth

  • 507636677fe9Revision changes
    • info

      the security scope chat:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope support_chat:read was removed from the endpoint's security scheme bearerAuth