Skip to Content
RankParseDocs
ChangelogDashboardGet API key
DocumentationAPI Reference
Outreach

Get prospecting context

Before topping up a campaign, read its room left, its send queue and every domain you have already used.

GEThttps://api.rankparse.com/v1/outreach/campaigns/:id/prospectingFreeAPI key

Returns what an agent needs before finding more prospects for an existing campaign: the campaign's context, how many contacts it can still take, its send queue on its mailbox, and exclude_domains, every prospect domain this workspace has already used in any campaign. Filter new prospects against that list, because research endpoints such as Competitor Gap return the same top results each time.

Path parameters

idstringrequired

The campaign id.

Response

campaignobject

id, name, your_domain, goal, status and paused.

capacityobject

contacts_total, max_contacts (500) and remaining_capacity.

queueobject

The campaign's emails and the mailbox it sends from.

Show properties
awaiting_launchinteger

Emails waiting for review or launch.

queuedinteger

Approved and waiting for the sending sweep. Also sending and sent.

auto_send_enabledboolean

Whether the campaign's mailbox is switched on. false when there is no mailbox.

max_sends_per_dayinteger

The mailbox's daily cap, lowered to the plan's cap when one applies.

remaining_todayinteger

Sends left today on that mailbox (UTC day).

needs_reconnectboolean

Present (and true) only when the mailbox is disconnected or Google stopped accepting it, together with a warning. Nothing in the queue sends until the user reconnects.

exclude_domainsarray of strings

Every prospect domain already used in any campaign of the workspace, capped at 5000.

exclude_domains_truncatedboolean

true when the list hit the cap. Prefer clearly new domains.

recommended_batch_sizeinteger

How many new prospects to look for: about a week of sending (7 times the daily cap, at least 10, or 20 without a mailbox), never more than 100 or the room left.

next_stepstring

One sentence: the campaign is full, it still has unsent emails, or how many new prospects to find.

Errors

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

Plus the shared errors.

MCP tool: outreach_suggest_prospects (accepts campaign_id).

Add contacts

Add the new prospects with their emails.

Competitor Gap

Find domains that link to competitors but not to you.

Update contacts

Rewrite the subject and body of emails already in a campaign that are still waiting for review.

Launch a campaign

Put a campaign's emails up for review (agents) or queue them for sending (direct calls).