HeyReach icon

HeyReach

Interact with HeyReach API

Inbox → Get Conversations

AI-generated

Summary

Retrieve conversations from the inbox based on specified filters.

Inputs

  • filters — Specify criteria to filter results, including LinkedIn account IDs, campaign IDs, search strings, and seen/unseen status.
  • returnAll — Determine whether to return all results or limit the count.
  • limit — Set a maximum number of results to return if 'Return All' is false.

Output shape

a list of conversation records

Can return all results or a limited set based on 'returnAll' and 'limit' parameters. If 'returnAll' is true, all matching conversations will be returned; if false, the results will be limited to the number specified in 'limit'.

Examples

Example 1: Retrieve the last 20 unseen conversations linked to specific LinkedIn accounts and campaigns.

Set 'returnAll' to false, 'limit' to 20, and provide necessary LinkedIn Account and Campaign IDs under 'filters'.

Example 2: Get all conversations containing the word 'meeting'.

Set 'returnAll' to true and fill 'searchString' with 'meeting', leaving other fields blank.

Discussion