Skip to Content
Outreach

Get a campaign

Read one campaign's status and how many of its emails are waiting, queued, sending, sent, skipped, replied to or bounced.

GEThttps://api.rankparse.com/v1/outreach/campaigns/:idFreeAPI key

Returns a campaign and the delivery counts of its emails. Use it to answer "how is my campaign doing?".

Path parameters

idstringrequired

The campaign id. An archived campaign or one outside your workspace returns 404 campaign_not_found.

Response

idstring

Campaign id.

namestring

Campaign name.

your_domainstring

The website the links are for.

goalstring | null

The goal note, if any.

statusstring
pausedboolean

true while the campaign is paused.

created_atinteger

Unix time in milliseconds.

site_idstring | null

The website the campaign belongs to.

site_hoststring | null

That website's host.

contactsobject

Email counts.

Show properties
totalinteger

Every contact in the campaign.

awaiting_launchinteger

Emails waiting for review or launch. Only these can be rewritten with Update contacts.

queuedinteger

Approved and waiting for the hourly sending sweep.

sendinginteger

Being sent right now.

sentinteger

Sent.

skippedinteger

Skipped, for example removed in review or suppressed because the address was emailed before.

repliedinteger

Sent emails marked as replied to. These are also counted in sent.

bouncedinteger

Sent emails marked as bounced. These are also counted in sent.

Errors

HTTPCodeWhen
403capability_missingYour role cannot view outreach.
404campaign_not_foundNot in your workspace, or archived.

Plus the shared errors.

MCP tool: outreach_get_campaign (accepts campaign_id).