GET /2/chat/conversations/{id}

Retrieves messages and key change events for a specific Chat conversation with pagination support. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.

Servers

Path parameters

Name Type Required Description
id String Yes

The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g').

Query parameters

Name Type Required Description
max_results Integer No

Maximum number of message events to return.

Default value: 10

chat_message_event.fields[] Array No

A comma separated list of ChatMessageEvent fields to display.

pagination_token String No

Token for pagination to retrieve the next page of results.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.