# List side conversations

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.

Endpoint: GET /conversations/{id}/side_conversations
Version: Preview
Security: bearerAuth

## Header parameters:

  - `Intercom-Version` (string)
    Intercom API version.By default, it's equal to the version set in the app package.
    Enum: "1.0", "1.1", "1.2", "1.3", "1.4", "2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "2.8", "2.9", "2.10", "2.11", "2.12", "2.13", "2.14", "Preview"

## Path parameters:

  - `id` (string, required)
    The identifier for the conversation as given by Intercom.
    Example: "123"

## Query parameters:

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

  - `per_page` (integer)
    The number of side conversations to return per page (max 50).

## Response 200 fields (application/json):

  - `type` (string)
    The type of the response object.
    Enum: "side_conversation.list"

  - `side_conversations` (array)
    An array of side conversation objects.

  - `side_conversations.side_conversation_id` (string)
    The unique identifier for the side conversation.
    Example: "456"

  - `side_conversations.conversation_parts` (array)
    The conversation parts (messages) in this side conversation.

  - `side_conversations.conversation_parts.type` (string)
    Always conversation_part
    Example: "conversation_part"

  - `side_conversations.conversation_parts.id` (string)
    The id representing the conversation part.
    Example: "3"

  - `side_conversations.conversation_parts.part_type` (string)
    The type of conversation part.
    Example: "comment"

  - `side_conversations.conversation_parts.body` (string,null)
    The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.
    Example: "<p>Okay!</p>"

  - `side_conversations.conversation_parts.created_at` (integer)
    The time the conversation part was created.
    Example: 1663597223

  - `side_conversations.conversation_parts.updated_at` (integer)
    The last time the conversation part was updated.
    Example: 1663597260

  - `side_conversations.conversation_parts.notified_at` (integer)
    The time the user was notified with the conversation part.
    Example: 1663597260

  - `side_conversations.conversation_parts.assigned_to` (object)
    reference to another object

  - `side_conversations.conversation_parts.assigned_to.type` (string)
    Example: "contact"

  - `side_conversations.conversation_parts.assigned_to.id` (string,null)
    Example: "1a2b3c"

  - `side_conversations.conversation_parts.author` (object)
    The author of this conversation part. Can be a Contact, Admin, or Bot.

  - `side_conversations.conversation_parts.author.type` (string)
    The type of the author
    Example: "admin"

  - `side_conversations.conversation_parts.author.id` (string)
    The id of the author
    Example: "274"

  - `side_conversations.conversation_parts.author.name` (string,null)
    The name of the author
    Example: "Operator"

  - `side_conversations.conversation_parts.author.email` (string)
    The email of the author
    Example: "operator+abcd1234@intercom.io"

  - `side_conversations.conversation_parts.author.from_ai_agent` (boolean)
    If this conversation part was sent by the AI Agent
    Example: true

  - `side_conversations.conversation_parts.author.is_ai_answer` (boolean)
    If this conversation part body was generated by the AI Agent

  - `side_conversations.conversation_parts.attachments` (array)
    A list of attachments for the part.

  - `side_conversations.conversation_parts.attachments.type` (string)
    The type of attachment
    Example: "upload"

  - `side_conversations.conversation_parts.attachments.name` (string)
    The name of the attachment
    Example: "example.png"

  - `side_conversations.conversation_parts.attachments.url` (string)
    The URL of the attachment
    Example: "https://picsum.photos/200/300"

  - `side_conversations.conversation_parts.attachments.content_type` (string)
    The content type of the attachment
    Example: "image/png"

  - `side_conversations.conversation_parts.attachments.filesize` (integer)
    The size of the attachment
    Example: 100

  - `side_conversations.conversation_parts.attachments.width` (integer)
    The width of the attachment
    Example: 100

  - `side_conversations.conversation_parts.attachments.height` (integer)
    The height of the attachment
    Example: 100

  - `side_conversations.conversation_parts.external_id` (string,null)
    The external id of the conversation part
    Example: "abcd1234"

  - `side_conversations.conversation_parts.redacted` (boolean)
    Whether or not the conversation part has been redacted.

  - `side_conversations.conversation_parts.email_message_metadata` (object)
    Contains metadata if the message was sent as an email

  - `side_conversations.conversation_parts.email_message_metadata.subject` (string)
    The subject of the email
    Example: "Question about my order"

  - `side_conversations.conversation_parts.email_message_metadata.email_address_headers` (array)
    A list of an email address headers.

  - `side_conversations.conversation_parts.email_message_metadata.email_address_headers.type` (string)
    The type of email address header
    Example: "from"

  - `side_conversations.conversation_parts.email_message_metadata.email_address_headers.email_address` (string)
    The email address
    Example: "jdoe@example.com"

  - `side_conversations.conversation_parts.email_message_metadata.email_address_headers.name` (string,null)
    The name associated with the email address
    Example: "Joe Example"

  - `side_conversations.conversation_parts.email_message_metadata.message_id` (string,null)
    The unique identifier for the email message as specified in the Message-ID header
    Example: "<CADKw7xrXzqSn8v3mP8K8Q8yZ6K8Q8yZ6@mail.gmail.com>"

  - `side_conversations.conversation_parts.metadata` (object)
    Metadata for a conversation part

  - `side_conversations.conversation_parts.metadata.quick_reply_options` (array)
    The quick reply options sent by the Admin or bot, presented in this conversation part.

  - `side_conversations.conversation_parts.metadata.quick_reply_options.translations` (object,null)
    The translations for the quick reply option.
    Example: {"en":"Hello","fr":"Bonjour"}

  - `side_conversations.conversation_parts.metadata.quick_reply_options.text` (string, required)
    The text to display in this quick reply option.

  - `side_conversations.conversation_parts.metadata.quick_reply_options.uuid` (string, required)
    A unique identifier for this quick reply option. This value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option.

  - `side_conversations.conversation_parts.metadata.quick_reply_uuid` (string)
    The unique identifier for the quick reply option that was clicked by the end user.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `side_conversations.conversation_parts.state` (string)
    Indicates the current state of conversation when the conversation part was created.
    Enum: "open", "closed", "snoozed"

  - `side_conversations.conversation_parts.tags` (array,null)
    A list of tags objects associated with the conversation part.

  - `side_conversations.conversation_parts.tags.type` (string)
    value is "tag"
    Example: "tag"

  - `side_conversations.conversation_parts.tags.id` (string)
    The id of the tag
    Example: "123456"

  - `side_conversations.conversation_parts.tags.name` (string)
    The name of the tag
    Example: "Test tag"

  - `side_conversations.conversation_parts.event_details` (object)

  - `side_conversations.conversation_parts.app_package_code` (string,null)
    The app package code if this part was created via API. null if the part was not created via API.
    Example: "test-integration"

  - `side_conversations.total_count` (integer)
    The total number of conversation parts in this side conversation.
    Example: 1

  - `total_count` (integer)
    The total number of side conversations.
    Example: 1

  - `pages` (object)
    Pagination metadata.

  - `pages.type` (string)
    Enum: "pages"

  - `pages.page` (integer)
    The current page number.
    Example: 1

  - `pages.per_page` (integer)
    The number of results per page.
    Example: 25

  - `pages.total_pages` (integer)
    The total number of pages.
    Example: 1

## Response 401 fields (application/json):

  - `type` (string, required)
    The type is error.list
    Example: "error.list"

  - `request_id` (string,null)
    Example: "f93ecfa8-d08a-4325-8694-89aeb89c8f85"

  - `errors` (array, required)
    An array of one or more error objects

  - `errors.code` (string, required)
    A string indicating the kind of error, used to further qualify the HTTP response code
    Example: "unauthorized"

  - `errors.message` (string,null)
    Optional. Human readable description of the error.
    Example: "Access Token Invalid"

  - `errors.field` (string,null)
    Optional. Used to identify a particular field or query parameter that was in error.
    Example: "email"