> ## 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: Inputs, Cost & CLI Example

> Getting a single HeyReach conversation thread and messages. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=heyreach_get_chatroom:{"account_id":"{{account_id}}","conversation_id":"{{conversation_id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                      | Type                | Required | Default | Description                              |
| ------------------------- | ------------------- | -------- | ------- | ---------------------------------------- |
| `payload.account_id`      | `integer \| string` | Yes      |         | Numeric id as integer or numeric string. |
| `payload.conversation_id` | `string`            | Yes      |         |                                          |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name            | Type     | Required | Default | Description |
| --------------- | -------- | -------- | ------- | ----------- |
| `result.status` | `string` | Yes      |         |             |
| `result.result` | `object` | Yes      |         |             |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute heyreach_get_chatroom --payload '{
  "account_id": "integer",
  "conversation_id": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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