Intercom: Retrieve Conversation

Get an Intercom conversation by its ID, with all its messages and parts.

Tool ID: intercom_retrieve_conversation

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_retrieve_conversation',
  {
    "conversation_id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_retrieve_conversation --input '{
  "conversation_id": 123
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "example",
    "id": "id_123",
    "title": "VP of Engineering"
  }
}

Use deepline describe intercom_retrieve_conversation --json for the latest machine-readable contract.

Input reference

You can fetch the details of a single conversation. This will return a single Conversation model with all its conversation parts. The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

Name	Type	Required	Default	Details
`payload.conversation_id`	`integer`	Yes	—	The id of the conversation to target
`payload.display_as`	`string`	No	—	Set to plaintext to retrieve conversation messages in plain text.
`payload.include_translations`	`boolean`	No	—	If set to true, conversation parts will be translated to the detected language of the conversation.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.
`result.data.type`	`string`	No	—	Always conversation.
`result.data.id`	`string`	No	—	The id representing the conversation.
`result.data.title`	`string \| null`	No	—	The title given to the conversation.
`result.data.created_at`	`integer`	No	—	The time the conversation was created. Format: `date-time`.
`result.data.updated_at`	`integer`	No	—	The last time the conversation was updated. Format: `date-time`.
`result.data.waiting_since`	`integer \| null`	No	—	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. Format: `date-time`.
`result.data.snoozed_until`	`integer \| null`	No	—	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. Format: `date-time`.
`result.data.open`	`boolean`	No	—	Indicates whether a conversation is open (true) or closed (false).
`result.data.state`	`"open" \| "closed" \| "snoozed"`	No	—	Can be set to “open”, “closed” or “snoozed”. Allowed: `open`, `closed`, `snoozed`.
`result.data.read`	`boolean`	No	—	Indicates whether a conversation has been read.
`result.data.priority`	`"priority" \| "not_priority"`	No	—	If marked as priority, it will return priority or else not_priority. Allowed: `priority`, `not_priority`.
`result.data.admin_assignee_id`	`integer \| null`	No	—	The id of the admin assigned to the conversation. If it’s not assigned to an admin it will return null.
`result.data.team_assignee_id`	`integer \| null`	No	—	The id of the team assigned to the conversation. If it’s not assigned to a team it will return null.
`result.data.company`	`object`	No	—	Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.
`result.data.company.type`	`"company"`	No	—	Value is `company` Allowed: `company`.
`result.data.company.id`	`string`	No	—	The Intercom defined id representing the company.
`result.data.company.name`	`string`	No	—	The name of the company.
`result.data.company.app_id`	`string`	No	—	The Intercom defined code of the workspace the company is associated to.
`result.data.company.plan`	`object`	No	—	—
`result.data.company.plan.type`	`string`	No	—	Value is always “plan”
`result.data.company.plan.id`	`string`	No	—	The id of the plan
`result.data.company.plan.name`	`string`	No	—	The name of the plan
`result.data.company.company_id`	`string`	No	—	The company id you have defined for the company.
`result.data.company.remote_created_at`	`integer`	No	—	The time the company was created by you.
`result.data.company.created_at`	`integer`	No	—	The time the company was added in Intercom.
`result.data.company.updated_at`	`integer`	No	—	The last time the company was updated.
`result.data.company.last_request_at`	`integer`	No	—	The time the company last recorded making a request.
`result.data.company.size`	`integer`	No	—	The number of employees in the company.
`result.data.company.website`	`string`	No	—	The URL for the company website.
`result.data.company.industry`	`string`	No	—	The industry that the company operates in.
`result.data.company.monthly_spend`	`integer`	No	—	How much revenue the company generates for your business.
`result.data.company.session_count`	`integer`	No	—	How many sessions the company has recorded.
`result.data.company.user_count`	`integer`	No	—	The number of users in the company.
`result.data.company.custom_attributes`	`record`	No	—	The custom attributes you have set on the company.
`result.data.company.tags`	`object`	No	—	The list of tags associated with the company
`result.data.company.tags.type`	`"tag.list"`	No	—	The type of the object Allowed: `tag.list`.
`result.data.company.tags.tags`	`array`	No	—	—
`result.data.company.tags.tags[].type`	`string`	No	—	value is “tag”
`result.data.company.tags.tags[].id`	`string`	No	—	The id of the tag
`result.data.company.tags.tags[].name`	`string`	No	—	The name of the tag
`result.data.company.segments`	`object`	No	—	The list of segments associated with the company
`result.data.company.segments.type`	`"segment.list"`	No	—	The type of the object Allowed: `segment.list`.
`result.data.company.segments.segments`	`array`	No	—	—
`result.data.company.segments.segments[].type`	`"segment"`	No	—	The type of object. Allowed: `segment`.
`result.data.company.segments.segments[].id`	`string`	No	—	The unique identifier representing the segment.
`result.data.company.segments.segments[].name`	`string`	No	—	The name of the segment.
`result.data.company.segments.segments[].created_at`	`integer`	No	—	The time the segment was created.
`result.data.company.segments.segments[].updated_at`	`integer`	No	—	The time the segment was updated.
`result.data.company.segments.segments[].person_type`	`"contact" \| "user"`	No	—	Type of the contact: contact (lead) or user. Allowed: `contact`, `user`.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe intercom_retrieve_conversation --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation