Sign in
Messages

List messages

Returns a paginated list of messages within a specific experience chat, DM, or group chat channel, sorted by creation time.

Required permissions (one of):

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

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

Changed in 50 of the 74 revisions of this API.1103

  • 78e1ed7366cd2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 73dd0533cd812See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 86b97292852d2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • c1dceb26e5052See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 7fcefabddb0a2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99662See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 35edb053220a2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a002See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • a88353507eac2See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

  • 51933d70d7f52See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-removed

Of the 74 revisions, 1 has no diff computed.