HeyReach: Get Conversations

Listing HeyReach inbox conversations with sender and campaign filters.

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.

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

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.

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.

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