Contacts
Companies
Deals
Pipelines
Lists
Tags
Campaigns
- GETList Campaigns
- POSTCreate Campaign
- GETGet Campaign
- PATCHUpdate Campaign
- DELDelete Campaign
- POSTStart Campaign
- POSTPause Campaign
- GETList Campaign Contacts
- POSTAdd Contacts to Campaign
- DELRemove Contact from Campaign
- GETList Campaign Steps
- POSTCreate Campaign Step
- PATCHUpdate Campaign Step
- DELDelete Campaign Step
- GETCampaign Stats
- GETCampaign Event Stream
Users
Stats & Analytics
Lexi AI
Audit Logs
AI Analysis
Documents
Import & Export
Workflows
Events
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>"
}
}
}Campaigns
Get Campaign
Retrieve a campaign’s full configuration including steps and contacts
GET
/
v1
/
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
The campaign’s unique ID (UUID)
Headers
Authorization: Bearer wbk_your_api_key_here
Requires an API key with the
campaigns:read permission.Response
Show properties
Show properties
Show Campaign object
Show Campaign object
Campaign UUID
Campaign name
Free-form description
draft, active, paused, or completedMaximum emails to send per day
Seconds to wait between sends within a day
IANA timezone (e.g.,
Europe/Berlin)Whether sends are allowed on Saturday and Sunday
Open tracking enabled
Click tracking enabled
Whether unsubscribe footer is appended
Array of step objects (subject, body, delay, send_condition)
Array of contact IDs enrolled in this campaign
ISO 8601 timestamp
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 |
⌘I