Skip to main content
GET
/
v1
/
campaigns
/
{id}
/
sequence
Get Campaign Sequence
curl --request GET \
  --url https://app-api.walead.ai/api/v1/campaigns/{id}/sequence \
  --header 'x-api-key: <api-key>'
{
  "campaignId": "<string>",
  "campaignName": "<string>",
  "steps": [
    {
      "id": "<string>",
      "type": "invitation",
      "order": 123,
      "delay": 123,
      "stopOnReply": true,
      "genericBody": "<string>",
      "messages": [
        {
          "id": "<string>",
          "body": "<string>",
          "order": 123,
          "isDisabled": true,
          "icpDefinitionRaw": "<string>",
          "aiTools": [
            {
              "name": "<string>",
              "key": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

​
Overview

Returns the complete message sequence for a campaign, including all steps and their message variants. This is a focused endpoint that returns only the sequencer data, making it ideal when you need to manage or display the campaign flow without additional campaign metadata.

​
What is a Sequence?

A sequence is the ordered series of steps that WaLead executes when reaching out to leads:
  • Steps: Individual actions in your outreach (invitation, message, profile visit, screener)
  • Variants: Different versions of messages for A/B testing (only for message and screener steps)
  • Order: Steps are executed in order with configurable delays between them

​
Response Structure

The response includes:
  • Campaign ID and name
  • Array of steps ordered by execution sequence
  • For each step: type, delay, and message variants
  • For each variant: message body, order, enabled status, and AI tools configuration

​
Use Cases

  • Display the campaign sequence in your UI
  • Export campaign templates
  • Analyze message variants and A/B testing setup
  • Validate sequence configuration before starting a campaign

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Path Parameters

​
id
string
required

Campaign ID

Response

Campaign sequence retrieved successfully

​
campaignId
string

Campaign identifier

​
campaignName
string

Campaign name

​
steps
object[]

Ordered array of campaign steps