AcquisityDeveloper Docs
Practical guides

Find and export leads

Preview your targeting, understand costs, then run the intended search.

Export leads already on a campaign

With campaignLeads:read, call Export campaign leads. Each response is a CSV page. If X-Next-Cursor is returned, request the next page with that cursor and identical filters. Only the first page includes column headings. A single response may not contain every lead.

Find new leads for a campaign

Use a workspace API key with campaigns:write.

  1. Prepare filters, or use AI filter suggestions to turn a brief into a proposed filter document.
  2. Preview the search. Review the filters and matching count; preview does not attach leads or spend credits.
  3. When ready to spend credits, submit those same filters and a leadCount to Search campaign leads. Use an Idempotency-Key to prevent an accidental repeat search on retry.
  4. Track the operation, then check the campaign's leads as they arrive.

Executing a search is the paid step. On an active campaign, new leads enter its live email sequence. Use a draft when preparing a campaign you do not want sending yet.

A successful campaign-search operation means the search was dispatched, not that every lead has arrived. Searching and attaching can take several minutes.

Find leads to use outside a campaign

Use standalone preview with leads:read, then standalone search with leads:search. These require a workspace API key. Send an Idempotency-Key for the paid request. The paid search's completed result includes downloadUrl and expiresAt; download the CSV before the link expires.

Check campaign results

Find a campaign and read its aggregate metrics without changing it.

Create a draft campaign

Build a campaign without launching it.

On this page

Export leads already on a campaignFind new leads for a campaignFind leads to use outside a campaign