Get Campaign

curl --request GET \
  --url https://api.example.com/v1/campaigns/{id}

{
  "data": {
    "campaign": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "daily_send_limit": 123,
      "delay_between_emails": 123,
      "sending_timezone": "<string>",
      "send_on_weekends": true,
      "track_opens": true,
      "track_clicks": true,
      "show_unsubscribe": true,
      "steps": [
        {}
      ],
      "contacts": [
        {}
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

GET

campaigns

{id}

Get Campaign

curl --request GET \
  --url https://api.example.com/v1/campaigns/{id}

{
  "data": {
    "campaign": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "daily_send_limit": 123,
      "delay_between_emails": 123,
      "sending_timezone": "<string>",
      "send_on_weekends": true,
      "track_opens": true,
      "track_clicks": true,
      "show_unsubscribe": true,
      "steps": [
        {}
      ],
      "contacts": [
        {}
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Request

Path Parameters

string

required

The campaign’s unique ID (UUID)

Headers

Authorization: Bearer wbk_your_api_key_here

Requires an API key with the campaigns:read permission.

Response

data

object

Show properties

campaign

object

Show Campaign object

string

Campaign UUID

name

string

Campaign name

description

string

Free-form description

status

string

draft, active, paused, or completed

daily_send_limit

integer

Maximum emails to send per day

delay_between_emails

integer

Seconds to wait between sends within a day

sending_timezone

string

IANA timezone (e.g., Europe/Berlin)

send_on_weekends

boolean

Whether sends are allowed on Saturday and Sunday

track_opens

boolean

Open tracking enabled

track_clicks

boolean

Click tracking enabled

show_unsubscribe

boolean

Whether unsubscribe footer is appended

steps

array

Array of step objects (subject, body, delay, send_condition)

contacts

array

Array of contact IDs enrolled in this campaign

created_at

string

ISO 8601 timestamp

updated_at

string

ISO 8601 timestamp

curl https://data.leadlex.com/functions/v1/api-gateway/v1/campaigns/cmp_abc123 \
  -H "Authorization: Bearer wbk_your_api_key_here"

Example Response

{
  "data": {
    "campaign": {
      "id": "cmp_abc123",
      "name": "Q2 GC Outreach",
      "description": "Warm outreach to general counsels at mid-market companies",
      "status": "active",
      "daily_send_limit": 50,
      "delay_between_emails": 120,
      "sending_timezone": "Europe/Berlin",
      "send_on_weekends": false,
      "track_opens": true,
      "track_clicks": true,
      "show_unsubscribe": true,
      "steps": [
        {
          "id": "step_1",
          "subject": "Quick question about {{company_name}}",
          "body": "Hi {{first_name}}, ...",
          "delay_days": 0,
          "delay_hours": 0,
          "send_condition": "always"
        }
      ],
      "contacts": ["123e4567-e89b-12d3-a456-426614174000"],
      "created_at": "2026-03-15T09:00:00Z",
      "updated_at": "2026-04-10T14:22:00Z"
    }
  }
}

Errors

Status	Code	Description
401	`invalid_key`	Invalid or expired API key
403	`insufficient_permissions`	Missing `campaigns:read` permission
404	`campaign_not_found`	No campaign with this ID
429	`rate_limited`	Rate limit exceeded

Create Campaign Update Campaign

​Request

​Path Parameters

​Headers

​Response

​Example Response

​Errors

Request

Path Parameters

Headers

Response

Example Response

Errors