younifyd
Menu

List Side Conversations

List side conversations

GET/conversations/{id}/side_conversations

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the List Side Conversations action (under Conversations).
  3. Fill in the fields below, then reference the result from later steps as {{listSideConversations.response.data}}.

Request

Path parameters

idstringrequired

The identifier for the conversation as given by Intercom.

Query parameters

pageinteger

The page number of results to return (starting from 1).

Default 1

per_pageinteger

The number of side conversations to return per page (max 50).

Default 25

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{listSideConversations.response.data.<field>}}.

typestring

The type of the response object.

One ofside_conversation.list

side_conversationsarray<object>

An array of side conversation objects.

side_conversation_idstring

The unique identifier for the side conversation.

conversation_partsarray<object>18 fields

The conversation parts (messages) in this side conversation.

total_countinteger

The total number of conversation parts in this side conversation.

total_countinteger

The total number of side conversations.

pagesobject

Pagination metadata.

typestring

One ofpages

pageinteger

The current page number.

per_pageinteger

The number of results per page.

total_pagesinteger

The total number of pages.

json
{
  "type": "side_conversation.list",
  "side_conversations": [
    {
      "side_conversation_id": "456",
      "conversation_parts": [
        {
          "type": "conversation_part",
          "id": "3",
          "part_type": "comment",
          "body": "<p>Okay!</p>",
          "created_at": 1663597223,
          "updated_at": 1663597260,
          "notified_at": 1663597260,
          "assigned_to": {
            "type": "contact",
            "id": "1a2b3c"
          },
          "author": {
            "type": "admin",
            "id": "274",
            "name": "Operator",
            "email": "operator+abcd1234@intercom.io",
            "from_ai_agent": true,
            "is_ai_answer": false
          },
          "attachments": [
            {
              "type": null,
              "name": null,
              "url": null,
              "content_type": null,
              "filesize": null,
              "width": null,
              "height": null
            }
          ],
          "external_id": "abcd1234",
          "redacted": false
        }
      ],
      "total_count": 1
    }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 25,
    "total_pages": 1
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.