# List leads

List leads is a read in the HeadHoncho API. Leads in the companies this credential reaches, newest first, with stage, service, estimate and where each came from.

Page: https://headhoncho.app/docs/api/list_leads | Part of the HeadHoncho API docs: https://headhoncho.app/docs/api | Machine-readable: https://headhoncho.app/docs/api/openapi.json | Everything in one file: https://headhoncho.app/docs/api/llms-full.txt

## The request

Reference for **List leads**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/leads`

The key needs the **Leads** area at **read**. An answered call costs 1 credit; a refusal costs nothing. See [credits](https://headhoncho.app/docs/api/errors#credits).

Send your key as `Authorization: Bearer hh_live_...`. See [API keys](https://headhoncho.app/docs/api/keys).

## Parameters

| Name | Kind | Required | Description | Example |
| --- | --- | --- | --- | --- |
| `company_id` | id, in the query | No | One company. Default: every company the credential reaches. | `cmp_14f5` |
| `stage` | text, in the query | No | new, taken, quoted, won, lost or passed. One of `new`, `taken`, `quoted`, `won`, `lost`, `passed`. | `new` |
| `bin` | text, in the query | No | Which leads: active (default, not in Archive), answer (still open), done (won, lost or passed) or archived. One of `active`, `answer`, `done`, `archived`. | `answer` |
| `limit` | number, in the query | No | 1 to 200. Default 50. | `50` |
| `cursor` | text, in the query | No | From the previous answer's next. | `eyJhZnRlciI6...` |

## Try it with your key

Paste your key and change the values. The box builds the call as a cURL line and a fetch line, ready to copy. It never sends anything itself.

Paste your key on the web page and it fills a cURL line and a fetch line with your key and the example values. The page never sends the key anywhere. The same lines with a placeholder key are under Examples below.

## What comes back

items, one lead each in the Get a lead shape without history; next, a cursor for the following page or null; count, how many match in all. Leads in Trash are not listed. estimate is {amount, source}: source is person when someone set it, or price_list. quoted is a number in the company's currency, or null.

It never changes a record. It only reads the companies the key reaches.

## Every field in the answer

Types are read from the example answer. Money is a plain number in the company's currency. A time carries its offset from UTC (`Z` is UTC). Ids are opaque text. A field with no line of its own here has its name spelled out; the common fields mean the same on every page.

| Field | Type | Meaning |
| --- | --- | --- |
| `items` | list of objects | The rows on this page. |
| `items[].id` | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
| `items[].number` | whole number | The number people say out loud, such as the job number. |
| `items[].ticket` | text | The job number the ticket shows. |
| `items[].company` | object | The company. |
| `items[].company.id` | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
| `items[].company.name` | text | The name, as the app shows it. |
| `items[].stage` | text | One of `new`, `taken`, `quoted`, `won`, `lost`, `passed`. |
| `items[].stage_since` | time (ISO 8601, with offset) | The moment: stage since. Carries its offset from UTC; `Z` is UTC. |
| `items[].client_name` | text | The customer's name. Hidden when the key hides personal details. |
| `items[].client_phone` | text | The customer's phone number. Hidden when the key hides personal details. |
| `items[].address` | object | The address. |
| `items[].address.line1` | text | The street address. Hidden when the key hides personal details. |
| `items[].address.city` | text | The city. |
| `items[].address.state` | text | The state or region. |
| `items[].service` | object | The service. |
| `items[].service.id` | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
| `items[].service.name` | text | The name, as the app shows it. |
| `items[].wanted_start` | time (ISO 8601, with offset) | The moment: wanted start. Carries its offset from UTC; `Z` is UTC. |
| `items[].wanted_end` | time (ISO 8601, with offset) | The moment: wanted end. Carries its offset from UTC; `Z` is UTC. |
| `items[].urgent` | true or false | The urgent. |
| `items[].notes` | text | Free-text notes. |
| `items[].estimate` | object | The estimate. |
| `items[].estimate.amount` | money (number) | The amount. In the company's currency. |
| `items[].estimate.source` | text | The source. |
| `items[].quoted` | value or null | The price quoted for the job. |
| `items[].lost_reason` | text | The lost reason. |
| `items[].pass_reason` | text | The pass reason. |
| `items[].job` | value or null | The job. |
| `items[].assigned_to` | value or null | The assigned to. |
| `items[].source` | object | The source. |
| `items[].source.kind` | text | What sort of thing this is. |
| `items[].source.label` | text | The name the app shows for it. |
| `items[].source.channel` | value or null | The channel. |
| `items[].arrivals` | whole number | The arrivals. |
| `items[].arrived_at` | time (ISO 8601, with offset) | When it was arrived. Carries its offset from UTC; `Z` is UTC. |
| `items[].missing` | list of text | The missing. |
| `items[].ready` | true or false | The ready. |
| `items[].archived_at` | time or null | When it was archived. |
| `items[].created_at` | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; `Z` is UTC. |
| `next` | value or null | The cursor for the next page, or null on the last page. Pass it back as `cursor`. |
| `count` | whole number | How many match in all, across every page. |

## Errors that apply

| Code | Status | What it means |
| --- | --- | --- |
| [`missing_key`](https://headhoncho.app/docs/api/errors#missing_key) | 401 | Send your key as Authorization: Bearer hh_live_... |
| [`unknown_key`](https://headhoncho.app/docs/api/errors#unknown_key) | 401 | That key is not one we issued, or it was revoked. |
| [`no_access`](https://headhoncho.app/docs/api/errors#no_access) | 403 | This credential does not reach that. Ask the person who made it for access. |
| [`not_found`](https://headhoncho.app/docs/api/errors#not_found) | 404 | No such record in the companies this credential reaches. |
| [`out_of_scope`](https://headhoncho.app/docs/api/errors#out_of_scope) | 404 | No such company in the companies this credential reaches. |
| [`invalid`](https://headhoncho.app/docs/api/errors#invalid) | 422 | Some fields were refused. See fields. |
| [`no_credits`](https://headhoncho.app/docs/api/errors#no_credits) | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |

## Related

- [Get lead](https://headhoncho.app/docs/api/get_lead): One lead: who, what and when they asked for, the estimate, its stage and what happened to it so far.
- [List needs you](https://headhoncho.app/docs/api/list_needs_you): Jobs that wait on a person, most urgent first, each with the reasons: no technician, unpaid cut, no answer and more.
- [List conversion reviews](https://headhoncho.app/docs/api/list_conversion_reviews): Ad clicks the matcher would not guess at. Each waits for you to pick the job it produced, or to reject it.
- The same records in the app: [the Leads panel](https://headhoncho.app/docs/marketing/sources).
- How the API fits together: [the model](https://headhoncho.app/docs/api/model), [API keys](https://headhoncho.app/docs/api/keys), [errors](https://headhoncho.app/docs/api/errors) and [the MCP server](https://headhoncho.app/docs/api/mcp).

## Examples

### Answer

```json
{
  "items": [
    {
      "id": "lead_5d21",
      "number": 2041,
      "ticket": "L-2041",
      "company": {
        "id": "cmp_14f5",
        "name": "Sunrise Moving"
      },
      "stage": "new",
      "stage_since": "2026-10-24T14:02:11Z",
      "client_name": "R. Azoulay",
      "client_phone": "+12175550142",
      "address": {
        "line1": "2590 Main St",
        "city": "Bloomington",
        "state": "IL"
      },
      "service": {
        "id": "jt_02",
        "name": "Local move"
      },
      "wanted_start": "2026-10-30T09:00:00Z",
      "wanted_end": "2026-10-30T12:00:00Z",
      "urgent": false,
      "notes": "Two flights of stairs",
      "estimate": {
        "amount": 1200.0,
        "source": "price_list"
      },
      "quoted": null,
      "lost_reason": "",
      "pass_reason": "",
      "job": null,
      "assigned_to": null,
      "source": {
        "kind": "call",
        "label": "Voice line",
        "channel": null
      },
      "arrivals": 1,
      "arrived_at": "2026-10-24T14:02:11Z",
      "missing": [
        "postal_code"
      ],
      "ready": false,
      "archived_at": null,
      "created_at": "2026-10-24T14:02:11Z"
    }
  ],
  "next": null,
  "count": 1
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/leads?company_id=cmp_14f5&stage=new" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/leads",
    headers={"Authorization": "Bearer hh_live_..."},
    params={
        "company_id": "cmp_14f5",
        "stage": "new",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/leads?company_id=cmp_14f5&stage=new", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_leads
Arguments: company_id (id, optional), stage (text, optional), bin (text, optional), limit (number, optional), cursor (text, optional)
Access: read on Leads
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list leads with company_id cmp_14f5."
```