---
title: "List leads"
method: GET
path: "/api/v1/leads"
tags: ["API Reference"]
---

# List leads

`GET /api/v1/leads`

## Request

- Base URL: `https://revnu.com`
- URL: `https://revnu.com/api/v1/leads`
- Auth: HTTP bearer

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. |

## Query parameters

- `status` string
- `limit` integer
- `cursor` string
- `workflowRunId` string

## Response `200`

{ "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

- object
  - `leads` object[], required
    - `id` string, required
    - `domain` string, required
    - `companyName` string, nullable, required
    - `status` 'bounced' | 'declined' | 'drafted' | 'partially_sent' | 'qualified' | 'replied' | 'sent', required
    - `replyKind` 'automatic' | 'human' | 'null', nullable, required
    - `declineReason` string, nullable, required
    - `score` number, nullable, required
    - `scoreReasons` string[], nullable, required
    - `vertical` string, nullable, required
    - `archetype` string, nullable, required
    - `tags` string[], required
    - `fields` object[], required
      - `key` string, required
      - `value` string, required
    - `contact` object, nullable, required
      - `name` string, nullable, required
      - `firstName` string, nullable, required
      - `title` string, nullable, required
      - `email` string, nullable, required
      - `emailStatus` string, nullable, required
      - `linkedinUrl` string, nullable, required
      - `photoUrl` string, nullable, required
    - `createdAt` number, required
    - `workflowRunId` string, nullable, required
    - `runContactIds` string[]
    - `runPeople` object[]
      - `name` string, required
      - `title` string, nullable, required
      - `email` string, nullable, required
      - `linkedinUrl` string, nullable, required
      - `profileUrl` string, nullable, required
      - `photoUrl` string, nullable, required
      - `role` 'champion' | 'economic' | 'technical' | 'user' | 'null', nullable, required
      - `alreadyKnown` boolean, required
    - `runCreatedLead` boolean
  - `nextCursor` string, nullable, required

## Other responses

- `400`: The request is malformed; the error names the problem.
- `401`: Missing, malformed, unknown or revoked token.
- `402`: `setup_pending`: the account hasn't started its trial. Finish setup with `GET /setup`.
- `403`: The token lacks the scope in `requiredScope`.
- `404`: workflowRunId is not one of your workflow runs.
- `429`: Rate limited.
- `503`: Temporarily unavailable; retry the same call.

---

[API](https://skmtc.dev/revnu/apis/revnu-api.md) · [All operations](https://skmtc.dev/revnu/apis/revnu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/revnu/apis/revnu-api/revisions/52e523c2db61?raw)
