> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HeyReach: Get Chatroom

> Get one HeyReach LinkedIn conversation with all its messages. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one HeyReach LinkedIn conversation with all its messages.

> [!NOTE]
>
> Tool ID: `heyreach_get_chatroom`

## 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_chatroom --input '{
  "account_id": 123,
  "conversation_id": "conversation_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "status": "example",
  "result": {
    "id": "id_123",
    "read": true,
    "groupChat": true,
    "blockedByMe": true,
    "blockedByParticipant": true,
    "lastMessageAt": "2026-01-15T12:00:00Z",
    "lastMessageText": "example",
    "lastMessageSender": "example",
    "totalMessages": 123,
    "campaignId": 123,
    "linkedInAccountId": 123,
    "correspondentProfile": {
      "profileUrl": "https://example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "headline": "example",
      "imageUrl": "https://example.com",
      "location": "example",
      "companyName": "Example Corp",
      "companyUrl": "https://example.com",
      "position": "example",
      "about": "example",
      "connections": 123,
      "followers": 123,
      "tags": [
        "example"
      ],
      "emailAddress": "jane.doe@example.com",
      "customFields": [
        {
          "name": "Example",
          "value": "example"
        }
      ]
    },
    "linkedInAccount": {
      "id": 123,
      "emailAddress": "jane.doe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "isActive": true,
      "activeCampaigns": 123,
      "authIsValid": true,
      "isValidNavigator": true,
      "isValidRecruiter": true
    },
    "messages": [
      {
        "createdAt": "2026-01-15T12:00:00Z",
        "body": "Example message",
        "subject": null,
        "postLink": null,
        "isInMail": true,
        "sender": "example"
      }
    ]
  }
}
```

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

## Input reference

HeyReach get chatroom input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.account_id` | `integer \| string` | Yes | — | Numeric id as integer or numeric string. |
| `payload.conversation_id` | `string` | Yes | — | Minimum length: 1. Maximum length: 500. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get chatroom input.",
    "properties": {
      "account_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      },
      "conversation_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    },
    "required": [
      "account_id",
      "conversation_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.id` | `string` | Yes | — | — |
| `result.result.read` | `boolean` | Yes | — | — |
| `result.result.groupChat` | `boolean` | Yes | — | — |
| `result.result.blockedByMe` | `boolean` | Yes | — | — |
| `result.result.blockedByParticipant` | `boolean` | Yes | — | — |
| `result.result.lastMessageAt` | `string` | Yes | — | — |
| `result.result.lastMessageText` | `string` | Yes | — | — |
| `result.result.lastMessageSender` | `string` | Yes | — | — |
| `result.result.totalMessages` | `integer` | Yes | — | — |
| `result.result.campaignId` | `integer` | Yes | — | — |
| `result.result.linkedInAccountId` | `integer` | Yes | — | — |
| `result.result.correspondentProfile` | `object` | Yes | — | — |
| `result.result.correspondentProfile.profileUrl` | `string` | Yes | — | — |
| `result.result.correspondentProfile.firstName` | `string` | Yes | — | — |
| `result.result.correspondentProfile.lastName` | `string` | Yes | — | — |
| `result.result.correspondentProfile.headline` | `string` | Yes | — | — |
| `result.result.correspondentProfile.imageUrl` | `string` | Yes | — | — |
| `result.result.correspondentProfile.location` | `string` | Yes | — | — |
| `result.result.correspondentProfile.companyName` | `string` | Yes | — | — |
| `result.result.correspondentProfile.companyUrl` | `string` | Yes | — | — |
| `result.result.correspondentProfile.position` | `string` | Yes | — | — |
| `result.result.correspondentProfile.about` | `string` | Yes | — | — |
| `result.result.correspondentProfile.connections` | `integer` | Yes | — | — |
| `result.result.correspondentProfile.followers` | `integer` | Yes | — | — |
| `result.result.correspondentProfile.tags` | `array` | Yes | — | — |
| `result.result.correspondentProfile.emailAddress` | `string` | Yes | — | — |
| `result.result.correspondentProfile.customFields` | `array` | Yes | — | — |
| `result.result.correspondentProfile.customFields[].name` | `string` | Yes | — | — |
| `result.result.correspondentProfile.customFields[].value` | `string` | Yes | — | — |
| `result.result.linkedInAccount` | `object` | Yes | — | — |
| `result.result.linkedInAccount.id` | `integer` | Yes | — | — |
| `result.result.linkedInAccount.emailAddress` | `string` | Yes | — | — |
| `result.result.linkedInAccount.firstName` | `string` | Yes | — | — |
| `result.result.linkedInAccount.lastName` | `string` | Yes | — | — |
| `result.result.linkedInAccount.isActive` | `boolean` | Yes | — | — |
| `result.result.linkedInAccount.activeCampaigns` | `integer` | Yes | — | — |
| `result.result.linkedInAccount.authIsValid` | `boolean` | Yes | — | — |
| `result.result.linkedInAccount.isValidNavigator` | `boolean` | Yes | — | — |
| `result.result.linkedInAccount.isValidRecruiter` | `boolean` | Yes | — | — |
| `result.result.messages` | `array` | Yes | — | — |
| `result.result.messages[].createdAt` | `string` | Yes | — | — |
| `result.result.messages[].body` | `string` | Yes | — | — |
| `result.result.messages[].subject` | `null` | Yes | — | — |
| `result.result.messages[].postLink` | `null` | Yes | — | — |
| `result.result.messages[].isInMail` | `boolean` | Yes | — | — |
| `result.result.messages[].sender` | `string` | Yes | — | — |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "read": {
            "type": "boolean"
          },
          "groupChat": {
            "type": "boolean"
          },
          "blockedByMe": {
            "type": "boolean"
          },
          "blockedByParticipant": {
            "type": "boolean"
          },
          "lastMessageAt": {
            "type": "string"
          },
          "lastMessageText": {
            "type": "string"
          },
          "lastMessageSender": {
            "type": "string"
          },
          "totalMessages": {
            "type": "integer"
          },
          "campaignId": {
            "type": "integer"
          },
          "linkedInAccountId": {
            "type": "integer"
          },
          "correspondentProfile": {
            "type": "object",
            "properties": {
              "profileUrl": {
                "type": "string"
              },
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "headline": {
                "type": "string"
              },
              "imageUrl": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "companyName": {
                "type": "string"
              },
              "companyUrl": {
                "type": "string"
              },
              "position": {
                "type": "string"
              },
              "about": {
                "type": "string"
              },
              "connections": {
                "type": "integer"
              },
              "followers": {
                "type": "integer"
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "emailAddress": {
                "type": "string"
              },
              "customFields": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "additionalProperties": true
                }
              }
            },
            "required": [
              "profileUrl",
              "firstName",
              "lastName",
              "headline",
              "imageUrl",
              "location",
              "companyName",
              "companyUrl",
              "position",
              "about",
              "connections",
              "followers",
              "tags",
              "emailAddress",
              "customFields"
            ],
            "additionalProperties": true
          },
          "linkedInAccount": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "emailAddress": {
                "type": "string"
              },
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "isActive": {
                "type": "boolean"
              },
              "activeCampaigns": {
                "type": "integer"
              },
              "authIsValid": {
                "type": "boolean"
              },
              "isValidNavigator": {
                "type": "boolean"
              },
              "isValidRecruiter": {
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "emailAddress",
              "firstName",
              "lastName",
              "isActive",
              "activeCampaigns",
              "authIsValid",
              "isValidNavigator",
              "isValidRecruiter"
            ],
            "additionalProperties": true
          },
          "messages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "createdAt": {
                  "type": "string"
                },
                "body": {
                  "type": "string"
                },
                "subject": {
                  "type": "null"
                },
                "postLink": {
                  "type": "null"
                },
                "isInMail": {
                  "type": "boolean"
                },
                "sender": {
                  "type": "string"
                }
              },
              "required": [
                "createdAt",
                "body",
                "subject",
                "postLink",
                "isInMail",
                "sender"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "id",
          "read",
          "groupChat",
          "blockedByMe",
          "blockedByParticipant",
          "lastMessageAt",
          "lastMessageText",
          "lastMessageSender",
          "totalMessages",
          "campaignId",
          "linkedInAccountId",
          "correspondentProfile",
          "linkedInAccount",
          "messages"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [HeyReach provider guide](https://deepline.com/docs/providers/heyreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.