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.
Send your key as Authorization: Bearer hh_live_.... See 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.
Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.
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` | 401 | Send your key as Authorization: Bearer hh_live_... |
| `unknown_key` | 401 | That key is not one we issued, or it was revoked. |
| `no_access` | 403 | This credential does not reach that. Ask the person who made it for access. |
| `invalid` | 422 | Some fields were refused. See fields. |
| `no_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- Get client: One client: name, phones and email, and their jobs, newest first.
- The same records in the app: the Jobs panel.
- How the API fits together: the model, API keys, errors and the MCP server.