> ## 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: List Lists

> List HeyReach lead and company lists, filtered by name, type or campaign. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

List HeyReach lead and company lists, filtered by name, type or campaign.

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

## 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_list_lists',
  {
    "offset": 123,
    "keyword": "software companies hiring engineers",
    "list_type": "USER_LIST"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_list_lists --input '{
  "offset": 123,
  "keyword": "software companies hiring engineers",
  "list_type": "USER_LIST"
}' --json
```

## Example response

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

## Input reference

HeyReach list lists input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.offset` | `integer` | No | — | Minimum: 0. |
| `payload.keyword` | `string` | No | — | — |
| `payload.list_type` | `"USER_LIST" \| "COMPANY_LIST"` | No | — | Allowed: `USER_LIST`, `COMPANY_LIST`. |
| `payload.campaign_ids` | `array` | No | — | — |
| `payload.limit` | `integer` | No | — | Minimum: 1. Maximum: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach list lists input.",
    "properties": {
      "offset": {
        "type": "integer",
        "minimum": 0
      },
      "keyword": {
        "type": "string"
      },
      "list_type": {
        "type": "string",
        "enum": [
          "USER_LIST",
          "COMPANY_LIST"
        ]
      },
      "campaign_ids": {
        "type": "array",
        "items": {
          "description": "Numeric id as integer or numeric string.",
          "anyOf": [
            {
              "type": "integer",
              "minimum": 1
            },
            {
              "type": "string",
              "minLength": 1,
              "pattern": "^\\d+$"
            }
          ]
        }
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    },
    "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[].id` | `integer` | Yes | — | — |
| `result.result.items[].name` | `string` | Yes | — | — |
| `result.result.items[].totalItemsCount` | `integer` | Yes | — | — |
| `result.result.items[].listType` | `string` | Yes | — | — |
| `result.result.items[].creationTime` | `string` | Yes | — | — |
| `result.result.items[].campaignIds` | `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": {
          "totalCount": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "name": {
                      "type": "string"
                    },
                    "totalItemsCount": {
                      "type": "integer"
                    },
                    "listType": {
                      "type": "string"
                    },
                    "creationTime": {
                      "type": "string"
                    },
                    "campaignIds": {
                      "type": "array",
                      "items": {
                        "type": "integer"
                      }
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "totalItemsCount",
                    "listType",
                    "creationTime",
                    "campaignIds"
                  ],
                  "additionalProperties": true
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "name": {
                      "type": "string"
                    },
                    "totalItemsCount": {
                      "type": "integer"
                    },
                    "listType": {
                      "type": "string"
                    },
                    "creationTime": {
                      "type": "string"
                    },
                    "campaignIds": {
                      "type": "array",
                      "items": {}
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "totalItemsCount",
                    "listType",
                    "creationTime",
                    "campaignIds"
                  ],
                  "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.