List side conversations

Request

List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation.

Each side conversation includes its conversation parts (messages). Results are paginated.

Requires the read_conversations OAuth scope.

Security

bearerAuth

Path

idstringrequired

The identifier for the conversation as given by Intercom.

Example:123

Query

pageinteger

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

Default:1

per_pageinteger, <= 50

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

Default:25

Intercom-Versionstring(intercom_version)

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

Default:"Preview"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X GET \
  'https://api.intercom.io/conversations/123/side_conversations?page=1&per_page=25' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Successful response

Bodyapplication/json

typestring

The type of the response object.

Value:"side_conversation.list"

Example:"side_conversation.list"

side_conversationsArray of objects(Side Conversation Summary)

An array of side conversation objects.

total_countinteger

The total number of side conversations.

Example:1

pagesobject

Pagination metadata.

Response

{
  "type": "side_conversation.list",
  "side_conversations": [
    { … }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 25,
    "total_pages": 1
  }
}