> ## 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: Inputs, Cost & CLI Example

> Listing HeyReach lead/company lists with pagination and filters. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=heyreach_list_lists:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                   | Type                            | Required | Default | Description |
| ---------------------- | ------------------------------- | -------- | ------- | ----------- |
| `payload.offset`       | `integer`                       | No       |         |             |
| `payload.keyword`      | `string`                        | No       |         |             |
| `payload.list_type`    | `"USER_LIST" \| "COMPANY_LIST"` | No       |         |             |
| `payload.campaign_ids` | `array`                         | No       |         |             |
| `payload.limit`        | `integer`                       | No       |         |             |

### Allowed values

| Field               | Allowed values              |
| ------------------- | --------------------------- |
| `payload.list_type` | `USER_LIST`, `COMPANY_LIST` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name            | Type     | Required | Default | Description |
| --------------- | -------- | -------- | ------- | ----------- |
| `result.status` | `string` | Yes      |         |             |
| `result.result` | `object` | Yes      |         |             |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute heyreach_list_lists --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.