> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.heyreach.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server.

# GetCampaignSequence

GET https://api//api/public/campaign/GetCampaignSequence?campaignId=<long>

## Retrieves the current sequence (workflow) of a campaign as a PublicSequenceNodeDto.

The returned object is directly compatible with the `sequence` field in **Create** and **UpdateSequence** - you can use it as-is without modification. Returns an empty 200 response if the campaign has no sequence.

### Query Parameters

- **campaignId** _(long, required)_: The campaign whose sequence to retrieve.

### Integration node payloads in the response

`SEND_LEAD_TO_*` payloads include the current state of the external lead flag (see **UpdateSequence** for the full schemas):

- `SEND_LEAD_TO_SMARTLEAD`: `pauseExternalLead` is always present.
    
- `SEND_LEAD_TO_INSTANTLY`: `removeExternalLead` is present only when `resourceType` is `CAMPAIGN`; it is omitted entirely for `LIST`.
    
- `SEND_LEAD_TO_BISON`: `stopExternalLead` is `null` when the node has no `bisonCampaignId`.
    

If you edit a response before sending it back, keep those rules in mind - adding `removeExternalLead` to a `LIST` node, or `stopExternalLead` to a node without a `bisonCampaignId`, is rejected with 400.

Reference: https://docs.heyreach.io/hey-reach-api/campaigns/get-campaign-sequence

## Request

### Query parameters

- `campaignId` (string, optional) — (Required) The campaign whose sequence to retrieve

### Headers

- `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}"

## Response

### 200

OK

- `nodeType` (string, required)
- `actionDelay` (integer, required)
- `actionDelayUnit` (string, required)
- `payload` (object, required)
  - `messages` (list of string, required)
  - `fallbackMessage` (string, required)
  - `toBeWithdrawnAfterDays` (integer, required)
- `conditionalNode` (object, required)
  - `nodeType` (string, required)
  - `actionDelay` (integer, required)
  - `actionDelayUnit` (string, required)
  - `payload` (object, required)
    - `messages` (list of string, required)
    - `fallbackMessage` (string, required)
  - `unconditionalNode` (object, required)
    - `nodeType` (string, required)
    - `actionDelay` (integer, required)
    - `actionDelayUnit` (string, required)
- `unconditionalNode` (object, required)
  - `nodeType` (string, required)
  - `actionDelay` (integer, required)
  - `actionDelayUnit` (string, required)

## Examples

**Response**

```json
{
  "nodeType": "CONNECTION_REQUEST",
  "actionDelay": 0,
  "actionDelayUnit": "DAY",
  "payload": {
    "messages": [
      "Hi {FIRST_NAME}, I'd love to connect!"
    ],
    "fallbackMessage": "Hi there, I'd love to connect!",
    "toBeWithdrawnAfterDays": 30
  },
  "conditionalNode": {
    "nodeType": "MESSAGE",
    "actionDelay": 2,
    "actionDelayUnit": "DAY",
    "payload": {
      "messages": [
        "Thanks for connecting, {FIRST_NAME}!"
      ],
      "fallbackMessage": "Thanks for connecting!"
    },
    "unconditionalNode": {
      "nodeType": "END",
      "actionDelay": 3,
      "actionDelayUnit": "HOUR"
    }
  },
  "unconditionalNode": {
    "nodeType": "END",
    "actionDelay": 3,
    "actionDelayUnit": "HOUR"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/campaign/GetCampaignSequence"

querystring = {"campaignId":"<long>"}

headers = {"X-API-KEY": "{{HR_API_KEY}}"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E';
const options = {method: 'GET', headers: {'X-API-KEY': '{{HR_API_KEY}}'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "{{HR_API_KEY}}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '{{HR_API_KEY}}'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E")
  .header("X-API-KEY", "{{HR_API_KEY}}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E', [
  'headers' => [
    'X-API-KEY' => '{{HR_API_KEY}}',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-KEY", "{{HR_API_KEY}}");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-KEY": "{{HR_API_KEY}}"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/campaign/GetCampaignSequence?campaignId=%3Clong%3E")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```