Get a campaign
Read one campaign's status and how many of its emails are waiting, queued, sending, sent, skipped, replied to or bounced.
https://api.rankparse.com/v1/outreach/campaigns/:idFreeAPI keyReturns a campaign and the delivery counts of its emails. Use it to answer "how is my campaign doing?".
Path parameters
idstringrequiredThe campaign id. An archived campaign or one outside your workspace returns 404 campaign_not_found.
Response
idstringCampaign id.
namestringCampaign name.
your_domainstringThe website the links are for.
goalstring | nullThe goal note, if any.
statusstringSee Campaign status.
pausedbooleantrue while the campaign is paused.
created_atintegerUnix time in milliseconds.
site_idstring | nullThe website the campaign belongs to.
site_hoststring | nullThat website's host.
contactsobjectEmail counts.
Show propertiesHide properties
totalintegerEvery contact in the campaign.
awaiting_launchintegerEmails waiting for review or launch. Only these can be rewritten with Update contacts.
queuedintegerApproved and waiting for the hourly sending sweep.
sendingintegerBeing sent right now.
sentintegerSent.
skippedintegerSkipped, for example removed in review or suppressed because the address was emailed before.
repliedintegerSent emails marked as replied to. These are also counted in sent.
bouncedintegerSent emails marked as bounced. These are also counted in sent.
Errors
| HTTP | Code | When |
|---|---|---|
| 403 | capability_missing | Your role cannot view outreach. |
| 404 | campaign_not_found | Not in your workspace, or archived. |
Plus the shared errors.
Related
MCP tool: outreach_get_campaign (accepts campaign_id).