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

> Listing HeyReach inbox conversations with sender and campaign filters. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.

## 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_conversations:{}' --json
```

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

## Input Schema

| Name              | Type      | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ----------- |
| `payload.filters` | `object`  | No       |         |             |
| `payload.offset`  | `integer` | No       |         |             |
| `payload.limit`   | `integer` | No       |         |             |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "HeyReach get conversations input.",
    "properties": {
      "filters": {
        "type": "object",
        "properties": {
          "linkedin_account_ids": {
            "type": "array",
            "items": {
              "description": "Numeric id as integer or numeric string.",
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 1
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "pattern": "^\\d+$"
                }
              ]
            }
          },
          "campaign_ids": {
            "type": "array",
            "items": {
              "description": "Numeric id as integer or numeric string.",
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 1
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "pattern": "^\\d+$"
                }
              ]
            }
          },
          "search_string": {
            "type": "string"
          },
          "lead_linkedin_id": {
            "type": "string"
          },
          "lead_profile_url": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "seen": {
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "additionalProperties": false
      },
      "offset": {
        "type": "integer",
        "minimum": 0
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    },
    "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": {
          "totalCount": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "read": {
                  "type": "boolean"
                },
                "groupChat": {
                  "type": "boolean"
                },
                "blockedByMe": {
                  "type": "boolean"
                },
                "blockedByParticipant": {
                  "type": "boolean"
                },
                "lastMessageAt": {
                  "type": "string"
                },
                "lastMessageText": {
                  "type": "string"
                },
                "lastMessageType": {
                  "type": "string"
                },
                "lastMessageSender": {
                  "type": "string"
                },
                "totalMessages": {
                  "type": "integer"
                },
                "linkedInAccountId": {
                  "type": "integer"
                },
                "correspondentProfile": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "linkedin_id": {
                      "type": "string"
                    },
                    "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": [
                    "id",
                    "linkedin_id",
                    "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",
                "lastMessageType",
                "lastMessageSender",
                "totalMessages",
                "linkedInAccountId",
                "correspondentProfile",
                "linkedInAccount",
                "messages"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "totalCount",
          "items"
        ],
        "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_conversations --payload '{}' --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`.