# Conversation List

Schema: #/components/schemas/conversation_list

Method: SCHEMA
Version: 2.7
Security: bearerAuth

## Schema fields:

  - `type` (string)
    Always conversation.list
    Enum: "conversation.list"

  - `conversations` (array)
    The list of conversation objects

  - `conversations.type` (string)
    Always conversation.
    Example: conversation

  - `conversations.id` (string)
    The id representing the conversation.
    Example: 1295

  - `conversations.title` (string)
    The title given to the conversation.
    Example: Conversation Title

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

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

  - `conversations.waiting_since` (integer)
    The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.
    Example: 1663597260

  - `conversations.snoozed_until` (integer)
    If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.
    Example: 1663597260

  - `conversations.open` (boolean)
    Indicates whether a conversation is open (true) or closed (false).
    Example: true

  - `conversations.state` (string)
    Can be set to "open", "closed" or "snoozed".
    Enum: "open", "closed", "snoozed"

  - `conversations.read` (boolean)
    Indicates whether a conversation has been read.
    Example: true

  - `conversations.priority` (string)
    If marked as priority, it will return priority or else not_priority.
    Enum: "priority", "not_priority"

  - `conversations.admin_assignee_id` (integer)
    The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.
    Example: 0

  - `conversations.team_assignee_id` (integer)
    The id of the team assigned to the conversation. If it's not assigned to a team it will return null.
    Example: 5017691

  - `conversations.tags` (object)
    A list of tags objects associated with a conversation

  - `conversations.tags.type` (string)
    The type of the object
    Enum: "tag.list"

  - `conversations.tags.tags` (array)
    A list of tags objects associated with the conversation.

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

  - `conversations.tags.tags.id` (string)
    The id of the tag
    Example: 123456

  - `conversations.tags.tags.name` (string)
    The name of the tag
    Example: Test tag

  - `conversations.tags.tags.applied_at` (integer)
    The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.
    Example: 1663597223

  - `conversations.tags.tags.applied_by` (object)
    The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.

  - `conversations.tags.tags.applied_by.type` (string)
    Example: contact

  - `conversations.tags.tags.applied_by.id` (string)
    Example: 1a2b3c

  - `conversations.conversation_rating` (object)
    The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.

  - `conversations.conversation_rating.rating` (integer)
    The rating, between 1 and 5, for the conversation.
    Example: 5

  - `conversations.conversation_rating.remark` (string)
    An optional field to add a remark to correspond to the number rating

  - `conversations.conversation_rating.created_at` (integer)
    The time the rating was requested in the conversation being rated.
    Example: 1671028894

  - `conversations.conversation_rating.contact` (object)
    reference to contact object

  - `conversations.conversation_rating.contact.type` (string)
    always contact
    Enum: "contact"

  - `conversations.conversation_rating.contact.id` (string)
    The unique identifier for the contact which is given by Intercom.
    Example: 5ba682d23d7cf92bef87bfd4

  - `conversations.conversation_rating.contact.external_id` (string)
    The unique identifier for the contact which is provided by the Client.
    Example: f3b87a2e09d514c6c2e79b9a

  - `conversations.source` (object)
    The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.

  - `conversations.source.type` (string)
    This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.
    Enum: "conversation", "email", "facebook", "instagram", "phone_call", "phone_switch", "push", "sms", "twitter", "whatsapp"

  - `conversations.source.id` (string)
    The id representing the message.
    Example: 3

  - `conversations.source.delivered_as` (string)
    The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).
    Example: operator_initiated

  - `conversations.source.subject` (string)
    Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.

  - `conversations.source.body` (string)
    The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.
    Example: <p>Hey there!</p>

  - `conversations.source.author` (object)
    The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

  - `conversations.source.author.type` (string)
    The type of the author
    Example: admin

  - `conversations.source.author.id` (string)
    The id of the author
    Example: 274

  - `conversations.source.author.name` (string)
    The name of the author. `null` if the author is a contact that has since been archived or deleted.
    Example: Operator

  - `conversations.source.author.email` (string)
    The email of the author. `null` if the author is a contact that has since been archived or deleted.
    Example: operator+abcd1234@intercom.io

  - `conversations.source.attachments` (array)
    A list of attachments for the part.

  - `conversations.source.attachments.type` (string)
    The type of attachment
    Example: upload

  - `conversations.source.attachments.name` (string)
    The name of the attachment
    Example: example.png

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

  - `conversations.source.attachments.content_type` (string)
    The content type of the attachment
    Example: image/png

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

  - `conversations.source.attachments.width` (integer)
    The width of the attachment
    Example: 100

  - `conversations.source.attachments.height` (integer)
    The height of the attachment
    Example: 100

  - `conversations.source.url` (string)
    The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.
    Example: null

  - `conversations.source.redacted` (boolean)
    Whether or not the source message has been redacted. Only applicable for contact initiated messages.
    Example: false

  - `conversations.contacts` (object)
    The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

  - `conversations.contacts.type` (string)
    Enum: "contact.list"

  - `conversations.contacts.contacts` (array)
    The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

  - `conversations.teammates` (object)
    The list of teammates who participated in the conversation (wrote at least one conversation part).

  - `conversations.teammates.type` (string)
    The type of the object - `admin.list`.
    Example: admin.list

  - `conversations.teammates.teammates` (array)
    The list of teammates who participated in the conversation (wrote at least one conversation part).

  - `conversations.first_contact_reply` (object)
    An object containing information on the first users message. For a contact initiated message this will represent the users original message.

  - `conversations.first_contact_reply.created_at` (integer)
    Example: 1663597223

  - `conversations.first_contact_reply.type` (string)
    Example: conversation

  - `conversations.first_contact_reply.url` (string)
    Example: https://developers.intercom.com/

  - `conversations.sla_applied` (object)
    The SLA Applied object contains the details for which SLA has been applied to this conversation.
Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.

  - `conversations.sla_applied.type` (string)
    object type
    Example: conversation_sla_summary

  - `conversations.sla_applied.sla_name` (string)
    The name of the SLA as given by the teammate when it was created.

  - `conversations.sla_applied.sla_status` (string)
    SLA statuses:
- `hit`
: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
- `missed`
: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.
- `active`
: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.
    Enum: "hit", "missed", "cancelled", "active"

  - `conversations.statistics` (object)
    A Statistics object containing all information required for reporting, with timestamps and calculated metrics.

  - `conversations.statistics.type` (string)
    Example: conversation_statistics

  - `conversations.statistics.time_to_assignment` (integer)
    Duration until last assignment before first admin reply. In seconds.
    Example: 2310

  - `conversations.statistics.time_to_admin_reply` (integer)
    Duration until first admin reply. Subtracts out of business hours. In seconds.
    Example: 2310

  - `conversations.statistics.time_to_first_close` (integer)
    Duration until conversation was closed first time. Subtracts out of business hours. In seconds.
    Example: 2310

  - `conversations.statistics.time_to_last_close` (integer)
    Duration until conversation was closed last time. Subtracts out of business hours. In seconds.
    Example: 2310

  - `conversations.statistics.median_time_to_reply` (integer)
    Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.
    Example: 2310

  - `conversations.statistics.first_contact_reply_at` (integer)
    Time of first text conversation part from a contact.
    Example: 1663597233

  - `conversations.statistics.first_assignment_at` (integer)
    Time of first assignment after first_contact_reply_at.
    Example: 1663597233

  - `conversations.statistics.first_admin_reply_at` (integer)
    Time of first admin reply after first_contact_reply_at.
    Example: 1663597233

  - `conversations.statistics.first_close_at` (integer)
    Time of first close after first_contact_reply_at.
    Example: 1663597233

  - `conversations.statistics.last_assignment_at` (integer)
    Time of last assignment after first_contact_reply_at.
    Example: 1663597233

  - `conversations.statistics.last_assignment_admin_reply_at` (integer)
    Time of first admin reply since most recent assignment.
    Example: 1663597233

  - `conversations.statistics.last_contact_reply_at` (integer)
    Time of the last conversation part from a contact.
    Example: 1663597233

  - `conversations.statistics.last_admin_reply_at` (integer)
    Time of the last conversation part from an admin.
    Example: 1663597233

  - `conversations.statistics.last_close_at` (integer)
    Time of the last conversation close.
    Example: 1663597233

  - `conversations.statistics.last_closed_by_id` (string)
    The last admin who closed the conversation. Returns a reference to an Admin object.
    Example: c3po

  - `conversations.statistics.count_reopens` (integer)
    Number of reopens after first_contact_reply_at.
    Example: 1

  - `conversations.statistics.count_assignments` (integer)
    Number of assignments after first_contact_reply_at.
    Example: 1

  - `conversations.statistics.count_conversation_parts` (integer)
    Total number of conversation parts.
    Example: 1

  - `total_count` (integer)
    A count of the total number of objects.
    Example: 12345

  - `pages` (object)
    Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.
A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

  - `pages.type` (string)
    the type of object `pages`.
    Enum: "pages"

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

  - `pages.next` (object)

  - `pages.next.per_page` (integer)
    The number of results to fetch per page.
    Example: 2

  - `pages.next.starting_after` (string)
    The cursor to use in the next request to get the next page of results.
    Example: your-cursor-from-response

  - `pages.per_page` (integer)
    Number of results per page
    Example: 2

  - `pages.total_pages` (integer)
    Total number of pages
    Example: 13

