> ## 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 Campaign Sequence

> Get the sequence steps of a HeyReach campaign: connection requests, messages, InMails, delays and branches. Includes SDK V2 examples, schemas, and cost.

Get the sequence steps of a HeyReach campaign: connection requests, messages, InMails, delays and branches.

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

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run heyreach_get_campaign_sequence --input '{
  "campaign_id": 123
}'
```

## Example response

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

## Input reference

HeyReach campaign ID input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `integer \| string` | Yes | — | Numeric id as integer or numeric string. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach campaign ID input.",
    "properties": {
      "campaign_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      }
    },
    "required": [
      "campaign_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.campaign_id` | `integer` | Yes | — | — |
| `result.result.sequence` | `object` | Yes | — | — |
| `result.result.sequence.nodeType` | `string` | Yes | — | — |
| `result.result.sequence.actionDelay` | `integer` | Yes | — | — |
| `result.result.sequence.actionDelayUnit` | `string` | Yes | — | — |
| `result.result.sequence.payload` | `object` | Yes | — | — |
| `result.result.sequence.payload.messages` | `array` | Yes | — | — |
| `result.result.sequence.payload.fallbackMessage` | `string` | Yes | — | — |
| `result.result.sequence.payload.toBeWithdrawnAfterDays` | `integer` | Yes | — | — |
| `result.result.sequence.conditionalNode` | `object` | Yes | — | — |
| `result.result.sequence.conditionalNode.nodeType` | `string` | Yes | — | — |
| `result.result.sequence.conditionalNode.actionDelay` | `integer` | Yes | — | — |
| `result.result.sequence.conditionalNode.actionDelayUnit` | `string` | Yes | — | — |
| `result.result.sequence.conditionalNode.payload` | `object` | Yes | — | — |
| `result.result.sequence.conditionalNode.payload.messages` | `array` | Yes | — | — |
| `result.result.sequence.conditionalNode.payload.fallbackMessage` | `string` | Yes | — | — |
| `result.result.sequence.conditionalNode.unconditionalNode` | `object` | Yes | — | — |
| `result.result.sequence.conditionalNode.unconditionalNode.nodeType` | `string` | Yes | — | — |
| `result.result.sequence.conditionalNode.unconditionalNode.actionDelay` | `integer` | Yes | — | — |
| `result.result.sequence.conditionalNode.unconditionalNode.actionDelayUnit` | `string` | Yes | — | — |
| `result.result.sequence.unconditionalNode` | `object` | Yes | — | — |
| `result.result.sequence.unconditionalNode.nodeType` | `string` | Yes | — | — |
| `result.result.sequence.unconditionalNode.actionDelay` | `integer` | Yes | — | — |
| `result.result.sequence.unconditionalNode.actionDelayUnit` | `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": {
          "campaign_id": {
            "type": "integer"
          },
          "sequence": {
            "type": "object",
            "properties": {
              "nodeType": {
                "type": "string"
              },
              "actionDelay": {
                "type": "integer"
              },
              "actionDelayUnit": {
                "type": "string"
              },
              "payload": {
                "type": "object",
                "properties": {
                  "messages": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "fallbackMessage": {
                    "type": "string"
                  },
                  "toBeWithdrawnAfterDays": {
                    "type": "integer"
                  }
                },
                "required": [
                  "messages",
                  "fallbackMessage",
                  "toBeWithdrawnAfterDays"
                ],
                "additionalProperties": true
              },
              "conditionalNode": {
                "type": "object",
                "properties": {
                  "nodeType": {
                    "type": "string"
                  },
                  "actionDelay": {
                    "type": "integer"
                  },
                  "actionDelayUnit": {
                    "type": "string"
                  },
                  "payload": {
                    "type": "object",
                    "properties": {
                      "messages": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "fallbackMessage": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "messages",
                      "fallbackMessage"
                    ],
                    "additionalProperties": true
                  },
                  "unconditionalNode": {
                    "type": "object",
                    "properties": {
                      "nodeType": {
                        "type": "string"
                      },
                      "actionDelay": {
                        "type": "integer"
                      },
                      "actionDelayUnit": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "nodeType",
                      "actionDelay",
                      "actionDelayUnit"
                    ],
                    "additionalProperties": true
                  }
                },
                "required": [
                  "nodeType",
                  "actionDelay",
                  "actionDelayUnit",
                  "payload",
                  "unconditionalNode"
                ],
                "additionalProperties": true
              },
              "unconditionalNode": {
                "type": "object",
                "properties": {
                  "nodeType": {
                    "type": "string"
                  },
                  "actionDelay": {
                    "type": "integer"
                  },
                  "actionDelayUnit": {
                    "type": "string"
                  }
                },
                "required": [
                  "nodeType",
                  "actionDelay",
                  "actionDelayUnit"
                ],
                "additionalProperties": true
              }
            },
            "required": [
              "nodeType",
              "actionDelay",
              "actionDelayUnit",
              "payload",
              "conditionalNode",
              "unconditionalNode"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "campaign_id",
          "sequence"
        ],
        "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

* [Connect integrations](https://deepline.com/docs/integrations.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.