> ## 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: Is Connection

> Check whether a lead is a first-degree LinkedIn connection of a HeyReach sender account. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Check whether a lead is a first-degree LinkedIn connection of a HeyReach sender account.

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

## 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_is_connection',
  {
    "sender_account_id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_is_connection --input '{
  "sender_account_id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "status": "example",
  "result": {
    "isConnection": true
  }
}
```

Use `deepline describe heyreach_is_connection --json` for the latest machine-readable contract.

## Input reference

HeyReach is connection input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.sender_account_id` | `integer \| string` | Yes | — | Numeric id as integer or numeric string. |
| `payload.lead_profile_url` | `string` | No | — | Minimum length: 1. Maximum length: 500. |
| `payload.lead_linkedin_id` | `string` | No | — | Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach is connection input.",
    "properties": {
      "sender_account_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      },
      "lead_profile_url": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "lead_linkedin_id": {
        "type": "string",
        "minLength": 1
      }
    },
    "required": [
      "sender_account_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.isConnection` | `boolean` | Yes | — | — |

<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": {
          "isConnection": {
            "type": "boolean"
          }
        },
        "required": [
          "isConnection"
        ],
        "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.