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

> Listing HeyReach inbox conversations with sender and campaign filters. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Listing HeyReach inbox conversations with sender and campaign filters.

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

## 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_conversations',
  {
    "filters": {
      "linkedin_account_ids": [
        123
      ],
      "campaign_ids": [
        123
      ],
      "search_string": "software companies hiring engineers"
    },
    "offset": 123,
    "limit": 100
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_conversations --input '{
  "filters": {
    "linkedin_account_ids": [
      123
    ],
    "campaign_ids": [
      123
    ],
    "search_string": "software companies hiring engineers"
  },
  "offset": 123,
  "limit": 100
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe heyreach_get_conversations --json` for the complete live contract.

## Input reference

HeyReach get conversations input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.filters` | `object` | No | — | — |
| `payload.offset` | `integer` | No | — | Minimum: 0. |
| `payload.limit` | `integer` | No | — | Minimum: 1. Maximum: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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 reference

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

The table shows the first 50 fields. Expand the raw schema below for every field.

<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": {
          "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>

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