List leads
Leads newest first with status, score, primary contact and your own columns, paged by an opaque cursor. Draft bodies are only on GET /leads/{id}.
Requires the leads:read scope.
Response. { "leads": [lead, …], "nextCursor": "…" | null }. A page is bounded in rows and in bytes, so pass nextCursor back until it is null.
A lead is { id, domain, companyName, status, replyKind, declineReason, score, scoreReasons, vertical, archetype, tags, fields, contact, createdAt, workflowRunId }, plus runContactIds, runPeople and runCreatedLead when you pass workflowRunId. workflowRunId is the workflow run that created the lead, or null. fields is your account's configured lead columns, exactly the dashboard table, as [{ key, value }] entries with each value cut at 1,000 characters, for example [{ "key": "account_case", "value": "…" }, { "key": "slack_thread", "value": "1790064680.268899" }]. The list never carries the draft or the research behind a value; read GET /leads/{id} for those.
| Code | Meaning |
|---|---|
| 404 | workflowRunId is not one of your workflow runs. |
Request
- Base URL: https://revnu.com
- URL: https://revnu.com/api/v1/leads
- Auth: HTTP bearer
Query parameters
Filter by lead status: qualified, drafted, sent, partially_sent, replied, declined or bounced. Anything else is a 400.
1 to 100. Default 50.
The nextCursor from the previous page.
Only the leads this workflow run created or returned people on (a run id from GET /workflows/{id}/runs). Each lead then also has runContactIds, the contacts this run created, runPeople, the people this run returned on the company's research list without saving them as contacts ({ name, title, email, linkedinUrl, profileUrl, photoUrl, role, alreadyKnown }; role is economic for the buyer, champion, technical, user or null, and alreadyKnown is true when the company had the person before this run), and runCreatedLead, true when the run created the lead itself.
Response
{ "leads": [lead, …], "nextCursor": "…" | null }. A page is bounded in rows and in bytes, so pass nextCursor back until it is null. A lead is { id, domain, companyName, status, replyKind, declineReason, score, scoreReasons, vertical, archetype, tags, fields, contact, createdAt, workflowRunId }, plus
Changes
No recorded changes to this operation across all 1 revision of this API.