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

> Getting full HeyReach lead details from profile URL. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Getting full HeyReach lead details from profile URL.

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

## 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_lead',
  {
    "profile_url": "https://example.com"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_lead --input '{
  "profile_url": "https://example.com"
}' --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": {
    "linkedin_id": "https://www.linkedin.com/in/jane-doe",
    "imageUrl": "https://example.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "fullName": "Example",
    "location": "example",
    "summary": "example",
    "companyName": "Example Corp",
    "companyUrl": "https://example.com",
    "position": "example",
    "industry": null,
    "about": null,
    "username": "user@example.com",
    "emailAddress": null,
    "connections": 123,
    "followers": 123,
    "experiences": "example",
    "education": "example",
    "profileUrl": "https://example.com",
    "enrichedEmailAddress": "jane.doe@example.com",
    "headline": null,
    "emailEnrichments": [
      "jane.doe@example.com"
    ]
  }
}
```

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

## Input reference

HeyReach get lead input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.profile_url` | `string` | Yes | — | Minimum length: 1. Maximum length: 500. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get lead input.",
    "properties": {
      "profile_url": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    },
    "required": [
      "profile_url"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.linkedin_id` | `string` | Yes | — | — |
| `result.result.imageUrl` | `string` | Yes | — | — |
| `result.result.firstName` | `string` | Yes | — | — |
| `result.result.lastName` | `string` | Yes | — | — |
| `result.result.fullName` | `string` | Yes | — | — |
| `result.result.location` | `string` | Yes | — | — |
| `result.result.summary` | `string` | Yes | — | — |
| `result.result.companyName` | `string` | Yes | — | — |
| `result.result.companyUrl` | `string` | Yes | — | — |
| `result.result.position` | `string` | Yes | — | — |
| `result.result.industry` | `null` | Yes | — | — |
| `result.result.about` | `null` | Yes | — | — |
| `result.result.username` | `string` | Yes | — | — |
| `result.result.emailAddress` | `null` | Yes | — | — |
| `result.result.connections` | `integer` | Yes | — | — |
| `result.result.followers` | `integer` | Yes | — | — |
| `result.result.experiences` | `string` | Yes | — | — |
| `result.result.education` | `string` | Yes | — | — |
| `result.result.profileUrl` | `string` | Yes | — | — |
| `result.result.enrichedEmailAddress` | `string` | Yes | — | — |
| `result.result.headline` | `null` | Yes | — | — |
| `result.result.emailEnrichments` | `array` | 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": {
          "linkedin_id": {
            "type": "string"
          },
          "imageUrl": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "fullName": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "companyName": {
            "type": "string"
          },
          "companyUrl": {
            "type": "string"
          },
          "position": {
            "type": "string"
          },
          "industry": {
            "type": "null"
          },
          "about": {
            "type": "null"
          },
          "username": {
            "type": "string"
          },
          "emailAddress": {
            "type": "null"
          },
          "connections": {
            "type": "integer"
          },
          "followers": {
            "type": "integer"
          },
          "experiences": {
            "type": "string"
          },
          "education": {
            "type": "string"
          },
          "profileUrl": {
            "type": "string"
          },
          "enrichedEmailAddress": {
            "type": "string"
          },
          "headline": {
            "type": "null"
          },
          "emailEnrichments": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "linkedin_id",
          "imageUrl",
          "firstName",
          "lastName",
          "fullName",
          "location",
          "summary",
          "companyName",
          "companyUrl",
          "position",
          "industry",
          "about",
          "username",
          "emailAddress",
          "connections",
          "followers",
          "experiences",
          "education",
          "profileUrl",
          "enrichedEmailAddress",
          "headline",
          "emailEnrichments"
        ],
        "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.