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

> Reading lead analytics rows for a HeyReach campaign. 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_get_leads_from_campaign:{"campaign_id":"{{campaign_id}}"}' --json
```

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

## Input Schema

| Name                  | Type                                                                                                       | Required | Default | Description                              |
| --------------------- | ---------------------------------------------------------------------------------------------------------- | -------- | ------- | ---------------------------------------- |
| `payload.campaign_id` | `integer \| string`                                                                                        | Yes      |         | Numeric id as integer or numeric string. |
| `payload.offset`      | `integer`                                                                                                  | No       |         |                                          |
| `payload.limit`       | `integer`                                                                                                  | No       |         |                                          |
| `payload.time_from`   | `string`                                                                                                   | No       |         |                                          |
| `payload.time_to`     | `string`                                                                                                   | No       |         |                                          |
| `payload.time_filter` | `"CreationTime" \| "Everywhere" \| "LastActionTakenTime" \| "FailedTime" \| "LastActionTakenOrFailedTime"` | No       |         |                                          |

### Allowed values

| Field                 | Allowed values                                                                                   |
| --------------------- | ------------------------------------------------------------------------------------------------ |
| `payload.time_filter` | `CreationTime`, `Everywhere`, `LastActionTakenTime`, `FailedTime`, `LastActionTakenOrFailedTime` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "HeyReach get leads from campaign input.",
    "properties": {
      "campaign_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
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000
      },
      "time_from": {
        "type": "string",
        "format": "date-time"
      },
      "time_to": {
        "type": "string",
        "format": "date-time"
      },
      "time_filter": {
        "type": "string",
        "enum": [
          "CreationTime",
          "Everywhere",
          "LastActionTakenTime",
          "FailedTime",
          "LastActionTakenOrFailedTime"
        ]
      }
    },
    "required": [
      "campaign_id"
    ],
    "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"
                    },
                    "linkedInUserProfileId": {
                      "type": "string"
                    },
                    "linkedInUserProfile": {
                      "type": "object",
                      "properties": {
                        "linkedin_id": {
                          "type": "string"
                        },
                        "profileUrl": {
                          "type": "string"
                        },
                        "firstName": {
                          "type": "string"
                        },
                        "lastName": {
                          "type": "string"
                        },
                        "headline": {
                          "type": "string"
                        },
                        "imageUrl": {
                          "type": "string"
                        },
                        "location": {
                          "type": "string"
                        },
                        "companyName": {
                          "type": "string"
                        },
                        "companyUrl": {
                          "type": "null"
                        },
                        "position": {
                          "type": "string"
                        },
                        "about": {
                          "type": "null"
                        },
                        "connections": {
                          "type": "integer"
                        },
                        "followers": {
                          "type": "integer"
                        },
                        "emailAddress": {
                          "type": "null"
                        }
                      },
                      "required": [
                        "linkedin_id",
                        "profileUrl",
                        "firstName",
                        "lastName",
                        "headline",
                        "imageUrl",
                        "location",
                        "companyName",
                        "companyUrl",
                        "position",
                        "about",
                        "connections",
                        "followers",
                        "emailAddress"
                      ],
                      "additionalProperties": true
                    },
                    "lastActionTime": {
                      "type": "string"
                    },
                    "failedTime": {
                      "type": "null"
                    },
                    "creationTime": {
                      "type": "string"
                    },
                    "leadCampaignStatus": {
                      "type": "string"
                    },
                    "leadConnectionStatus": {
                      "type": "string"
                    },
                    "leadMessageStatus": {
                      "type": "string"
                    },
                    "errorCode": {
                      "type": "null"
                    },
                    "leadCampaignStatusMessage": {
                      "type": "null"
                    },
                    "linkedInSenderId": {
                      "type": "integer"
                    },
                    "linkedInSenderFullName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "linkedInUserProfileId",
                    "linkedInUserProfile",
                    "lastActionTime",
                    "failedTime",
                    "creationTime",
                    "leadCampaignStatus",
                    "leadConnectionStatus",
                    "leadMessageStatus",
                    "errorCode",
                    "leadCampaignStatusMessage",
                    "linkedInSenderId",
                    "linkedInSenderFullName"
                  ],
                  "additionalProperties": true
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "linkedInUserProfileId": {
                      "type": "string"
                    },
                    "linkedInUserProfile": {
                      "type": "object",
                      "properties": {
                        "linkedin_id": {
                          "type": "string"
                        },
                        "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"
                        },
                        "emailAddress": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "linkedin_id",
                        "profileUrl",
                        "firstName",
                        "lastName",
                        "headline",
                        "imageUrl",
                        "location",
                        "companyName",
                        "companyUrl",
                        "position",
                        "about",
                        "connections",
                        "followers",
                        "emailAddress"
                      ],
                      "additionalProperties": true
                    },
                    "lastActionTime": {
                      "type": "string"
                    },
                    "failedTime": {
                      "type": "null"
                    },
                    "creationTime": {
                      "type": "string"
                    },
                    "leadCampaignStatus": {
                      "type": "string"
                    },
                    "leadConnectionStatus": {
                      "type": "string"
                    },
                    "leadMessageStatus": {
                      "type": "string"
                    },
                    "errorCode": {
                      "type": "null"
                    },
                    "leadCampaignStatusMessage": {
                      "type": "null"
                    },
                    "linkedInSenderId": {
                      "type": "integer"
                    },
                    "linkedInSenderFullName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "linkedInUserProfileId",
                    "linkedInUserProfile",
                    "lastActionTime",
                    "failedTime",
                    "creationTime",
                    "leadCampaignStatus",
                    "leadConnectionStatus",
                    "leadMessageStatus",
                    "errorCode",
                    "leadCampaignStatusMessage",
                    "linkedInSenderId",
                    "linkedInSenderFullName"
                  ],
                  "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_get_leads_from_campaign --payload '{
  "campaign_id": "integer"
}' --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`.