Skip to main content
GET
/
v1
/
campaigns
/
{id}
Get Campaign by ID
curl --request GET \
  --url https://app-api.walead.ai/api/v1/campaigns/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "progress": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "settings": {},
  "coreVariables": {},
  "customVariables": {},
  "linkedinAccounts": [
    "<string>"
  ],
  "analytics": {
    "acceptanceRate": 123,
    "responseRate": 123,
    "totalLeads": 123
  },
  "steps": [
    {
      "id": "<string>",
      "order": 123,
      "delay": 123,
      "stopOnReply": true,
      "genericBody": "<string>",
      "variants": [
        {
          "id": "<string>",
          "body": "<string>",
          "order": 123,
          "isDisabled": true,
          "icpDefinitionRaw": "<string>",
          "stepId": "<string>",
          "aiTools": [
            {
              "name": "<string>",
              "key": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.walead.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Retrieves a single campaign by its ID, including complete details about the campaign configuration, analytics, and message sequence. The campaign must belong to your workspace.

​
What’s Included

This endpoint returns comprehensive campaign data:
  • Basic Info: ID, name, status, progress, creation date
  • Configuration: Settings, core variables, custom variables
  • LinkedIn Accounts: Associated account IDs
  • Analytics: Acceptance rate, response rate, total leads
  • Sequence: Complete array of steps with their message variants

​
Sequence Data

The response includes the full campaign sequence (steps and variants), making this endpoint ideal when you need both campaign metadata and the message flow. If you only need the sequence, use the dedicated Get Campaign Sequence endpoint instead. Each step in the sequence includes:
  • Step type (invitation, message, visit_profile, screener)
  • Order and delay configuration
  • Message variants for A/B testing (for message and screener steps)
  • AI tools configuration per variant

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 retrieved successfully

​
id
string

Unique campaign identifier

​
name
string

Campaign name

​
status
enum<string>

Campaign status

Available options:
active,
paused,
completed,
error,
draft
​
progress
number

Campaign progress percentage (0-100)

​
createdAt
string<date-time>

ISO 8601 timestamp of creation

​
settings
object

Campaign configuration settings

​
coreVariables
object

Core variables enabled for this campaign

​
customVariables
object

Custom variables defined for this campaign

​
linkedinAccounts
string[]

Array of LinkedIn account IDs associated with the campaign

​
analytics
object
​
steps
object[]

Campaign sequence steps with message variants