GET/campaigns/:campaignId
Return one campaign. 0 credits. Rate class: global. Detail shape matches the list item.
Request
GET /campaigns/search-xyz
X-API-Key: sk_live_...
Response
{
"id": "search-xyz",
"name": "Dentists in Austin",
"status": "READY_TO_SEND",
"totalLeads": 48,
"assignedTemplateId": null,
"stats": {
"emailsSent": 0,
"repliesReceived": 0,
"replyRate": null,
"emailsOpened": 0,
"openRate": null
}
}
| Field | Type |
|---|---|
id | string |
name | string |
status | string |
totalLeads | number |
assignedTemplateId | string | null |
stats.emailsSent | number |
stats.repliesReceived | number |
stats.replyRate | number | null |
stats.emailsOpened | number |
stats.openRate | number | null |
Errors
| Error code | When |
|---|---|
not_found | Unknown campaign |
MCP
Tool: get_campaign.