> ## 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 Leads From List

> List the leads in a HeyReach list, searchable by keyword, profile URL or date added. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the leads in a HeyReach list, searchable by keyword, profile URL or date added.

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

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

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

### CLI

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

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe heyreach_get_leads_from_list --json` for the complete live contract.

## Input reference

HeyReach get leads from list input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.list_id` | `integer \| string` | Yes | — | Numeric id as integer or numeric string. |
| `payload.offset` | `integer` | No | — | Minimum: 0. |
| `payload.keyword` | `string` | No | — | — |
| `payload.lead_profile_url` | `string` | No | — | — |
| `payload.lead_linkedin_id` | `string` | No | — | — |
| `payload.limit` | `integer` | No | — | Minimum: 1. Maximum: 1000. |
| `payload.created_from` | `string` | No | — | Format: `date-time`. |
| `payload.created_to` | `string` | No | — | Format: `date-time`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get leads from list input.",
    "properties": {
      "list_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      },
      "offset": {
        "type": "integer",
        "minimum": 0
      },
      "keyword": {
        "type": "string"
      },
      "lead_profile_url": {
        "type": "string"
      },
      "lead_linkedin_id": {
        "type": "string"
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000
      },
      "created_from": {
        "type": "string",
        "format": "date-time"
      },
      "created_to": {
        "type": "string",
        "format": "date-time"
      }
    },
    "required": [
      "list_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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[].profileUrl` | `string` | Yes | — | — |
| `result.result.items[].firstName` | `string` | Yes | — | — |
| `result.result.items[].lastName` | `string` | Yes | — | — |
| `result.result.items[].headline` | `string` | Yes | — | — |
| `result.result.items[].imageUrl` | `string` | Yes | — | — |
| `result.result.items[].location` | `string` | Yes | — | — |
| `result.result.items[].companyName` | `string` | Yes | — | — |
| `result.result.items[].companyUrl` | `string` | Yes | — | — |
| `result.result.items[].position` | `string` | Yes | — | — |
| `result.result.items[].about` | `string` | Yes | — | — |
| `result.result.items[].connections` | `integer` | Yes | — | — |
| `result.result.items[].followers` | `integer` | Yes | — | — |
| `result.result.items[].tags` | `array` | Yes | — | — |
| `result.result.items[].emailAddress` | `string` | Yes | — | — |
| `result.result.items[].customFields` | `array` | Yes | — | — |
| `result.result.items[].customFields[].name` | `string` | Yes | — | — |
| `result.result.items[].customFields[].value` | `string` | 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": {
          "totalCount": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "profileUrl": {
                  "type": "string"
                },
                "firstName": {
                  "type": "string"
                },
                "lastName": {
                  "type": "string"
                },
                "headline": {
                  "type": "string"
                },
                "imageUrl": {
                  "type": "string"
                },
                "location": {
                  "type": "string"
                },
                "companyName": {
                  "type": "string"
                },
                "companyUrl": {
                  "type": "string"
                },
                "position": {
                  "type": "string"
                },
                "about": {
                  "type": "string"
                },
                "connections": {
                  "type": "integer"
                },
                "followers": {
                  "type": "integer"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "emailAddress": {
                  "type": "string"
                },
                "customFields": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "value"
                    ],
                    "additionalProperties": true
                  }
                }
              },
              "required": [
                "profileUrl",
                "firstName",
                "lastName",
                "headline",
                "imageUrl",
                "location",
                "companyName",
                "companyUrl",
                "position",
                "about",
                "connections",
                "followers",
                "tags",
                "emailAddress",
                "customFields"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "totalCount",
          "items"
        ],
        "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.