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

> Listing paginated companies from a HeyReach company list. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Listing paginated companies from a HeyReach company list.

> [!NOTE]
>
> Tool ID: `heyreach_get_companies_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_companies_from_list',
  {
    "list_id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_companies_from_list --input '{
  "list_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": {
    "totalCount": 123,
    "items": [
      {
        "name": "Example",
        "description": "Example description",
        "industry": "example",
        "imageUrl": "https://example.com",
        "companySize": "example",
        "employeesOnLinkedIn": 123,
        "location": "example",
        "specialities": "example",
        "website": "https://example.com"
      }
    ]
  }
}
```

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

## Input reference

HeyReach get companies 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.limit` | `integer` | No | — | Minimum: 1. Maximum: 1000. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get companies 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"
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000
      }
    },
    "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[].name` | `string` | Yes | — | — |
| `result.result.items[].description` | `string` | Yes | — | — |
| `result.result.items[].industry` | `string` | Yes | — | — |
| `result.result.items[].imageUrl` | `string` | Yes | — | — |
| `result.result.items[].companySize` | `string` | Yes | — | — |
| `result.result.items[].employeesOnLinkedIn` | `integer` | Yes | — | — |
| `result.result.items[].location` | `string` | Yes | — | — |
| `result.result.items[].specialities` | `string` | Yes | — | — |
| `result.result.items[].website` | `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": {
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "industry": {
                  "type": "string"
                },
                "imageUrl": {
                  "type": "string"
                },
                "companySize": {
                  "type": "string"
                },
                "employeesOnLinkedIn": {
                  "type": "integer"
                },
                "location": {
                  "type": "string"
                },
                "specialities": {
                  "type": "string"
                },
                "website": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "description",
                "industry",
                "imageUrl",
                "companySize",
                "employeesOnLinkedIn",
                "location",
                "specialities",
                "website"
              ],
              "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.