# List clients

List clients is a read in the HeadHoncho API. The people behind your jobs, by name, with their phones and how many jobs each has.

Page: https://headhoncho.app/docs/api/list_clients | 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 clients**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/clients`

The key needs the **Jobs** 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 |
| --- | --- | --- | --- | --- |
| `q` | text, in the query | No | Part of a name or a phone number. | `azoulay` |
| `limit` | number, in the query | No | 1 to 200. Default 50. | `50` |
| `cursor` | text, in the query | No | From the previous answer's next. | `eyJhZnRlciI6IlIuIEF6b3VsYXkifQ` |

## 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 client each: id, name, phone, second_phone, email, job_count (jobs not in Trash), last_job_at and created_at. next is a cursor for the following page or null. count is how many match in all. With personal details hidden, names become initials, phones keep their last four and email is empty.

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[].name` | text | The name, as the app shows it. |
| `items[].phone` | text | A phone number. Hidden when the key hides personal details. |
| `items[].second_phone` | text | A second phone number. Hidden when the key hides personal details. |
| `items[].email` | text | The email. |
| `items[].job_count` | whole number | The job count. |
| `items[].last_job_at` | time (ISO 8601, with offset) | When the last job happened. Carries its offset from UTC; `Z` is UTC. |
| `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. |

## Needs every company

The client book is the whole workspace's, not one company's. A credential that reaches only some companies is refused with no_access, so it can never read or change a person who also belongs to a company it cannot see.

## 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. |
| [`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 client](https://headhoncho.app/docs/api/get_client): One client: name, phones and email, and their jobs, newest first.
- The same records in the app: [the Jobs panel](https://headhoncho.app/docs/jobs).
- 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": "cli_9c40",
      "name": "R. Azoulay",
      "phone": "+12175550142",
      "second_phone": "",
      "email": "r.azoulay@example.com",
      "job_count": 3,
      "last_job_at": "2026-10-11T18:25:40Z",
      "created_at": "2026-08-02T15:10:00Z"
    }
  ],
  "next": null,
  "count": 1
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/clients?q=azoulay&limit=50" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/clients",
    headers={"Authorization": "Bearer hh_live_..."},
    params={
        "q": "azoulay",
        "limit": "50",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/clients?q=azoulay&limit=50", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_clients
Arguments: q (text, optional), limit (number, optional), cursor (text, optional)
Access: read on Jobs
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list clients with q azoulay."
```