GetConversationsV2 | HeyReach API Documentation

curl -X POST https://api/api/public/inbox/GetConversationsV2 \
     -H "X-API-KEY: <string>" \
     -H "Content-Type: application/json" \
     -d '{
  "filters": {
    "linkedInAccountIds": [],
    "campaignIds": [],
    "searchString": "",
    "leadLinkedInId": "",
    "leadProfileUrl": "https://www.linkedin.com/in/john_doe/",
    "tags": [
      "Lead tag1",
      "Lead Tag2"
    ]
  },
  "offset": 0,
  "limit": 10
}'

{
  "totalCount": 1,
  "items": [
    {
      "id": "string",
      "read": true,
      "groupChat": true,
      "blockedByMe": true,
      "blockedByParticipant": true,
      "lastMessageAt": "2025-03-28T12:00:19Z",
      "lastMessageText": "string",
      "lastMessageType": "TEXT",
      "lastMessageSender": "ME",
      "totalMessages": 0,
      "linkedInAccountId": 0,
      "correspondentProfile": {
        "id": "string",
        "linkedin_id": "string",
        "profileUrl": "string",
        "firstName": "string",
        "lastName": "string",
        "headline": "string",
        "imageUrl": "string",
        "location": "string",
        "companyName": "string",
        "companyUrl": "string",
        "position": "string",
        "about": "string",
        "connections": 0,
        "followers": 0,
        "tags": [
          "string"
        ],
        "emailAddress": "string",
        "customFields": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "linkedInAccount": {
        "id": 0,
        "emailAddress": "string",
        "firstName": "string",
        "lastName": "string",
        "authIsValid": true,
        "isValidNavigator": true,
        "isValidRecruiter": true,
        "profileUrl": "https://www.linkedin.com/in/john_doe-12b36a384"
      },
      "messages": [
        {
          "createdAt": "2025-03-28T12:00:19Z",
          "body": "string",
          "subject": "string",
          "postLink": "string",
          "isInMail": true,
          "sender": "ME"
        }
      ]
    }
  ]
}

Get a paginated collection of LinkedIn conversations. Get up to 100 lists per request.

Body Parameters

filters
- linkedInAccountIds (int[]): The ids of the LinkedIn senders
- campaignIds (int[])
- searchString (string, optional)
- leadLinkedInId (string, optional) - The LinkedIn ID of the lead. You can find this ID as “linkedin_id” in the response of many of our endpoints, for example in the ‘/api/public/lead/GetLead’ endpoint.
- leadProfileUrl (string, optional) - The linkedin URL of the lead
- searchString (string, optional)
- tags - case-insensitive list of lead’s tags. Only the conversations of the leads that have at least one of the tags will be exported.
- seen (boolean. optional)

Get a paginated collection of LinkedIn conversations. Get up to 100 lists per request. ### Body Parameters - **filters** - **linkedInAccountIds** (int\[\])**:** The ids of the LinkedIn senders - **campaignIds** (int\[\]) - **searchString** (string, optional) - **leadLinkedInId** (string, optional) - The LinkedIn ID of the lead. You can find this ID as "linkedin_id" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint. - **leadProfileUrl** (string, optional) - The linkedin URL of the lead - **searchString** (string, optional) - **tags -** case-insensitive list of lead's tags. Only the conversations of the leads that have at least one of the tags will be exported. - **seen (boolean. optional)**

Request

This endpoint expects an object.

filtersobjectRequired

offsetintegerRequired

limitintegerRequired

Response

totalCountinteger

itemslist of objects

Get a paginated collection of LinkedIn conversations. Get up to 100 lists per request.

Body Parameters

filters
- linkedInAccountIds (int[]): The ids of the LinkedIn senders
- campaignIds (int[])
- searchString (string, optional)
- leadLinkedInId (string, optional) - The LinkedIn ID of the lead. You can find this ID as “linkedin_id” in the response of many of our endpoints, for example in the ‘/api/public/lead/GetLead’ endpoint.
- leadProfileUrl (string, optional) - The linkedin URL of the lead
- searchString (string, optional)
- tags - case-insensitive list of lead’s tags. Only the conversations of the leads that have at least one of the tags will be exported.
- seen (boolean. optional)

Body Parameters

Headers

Request

Response

Body Parameters