The request
Reference for Get client, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/clients/{client_id}
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 |
|---|---|---|---|---|
client_id | id, in the path | Yes | The client id, from List clients. | cli_9c40 |
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
The client in the List clients shape, and jobs: up to 100, newest first, each with id, number, status and created_at. Jobs in Trash are not listed.
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 |
|---|---|---|
id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
name | text | The name, as the app shows it. |
phone | text | A phone number. Hidden when the key hides personal details. |
second_phone | text | A second phone number. Hidden when the key hides personal details. |
email | text | The email. |
job_count | whole number | The job count. |
last_job_at | time (ISO 8601, with offset) | When the last job happened. Carries its offset from UTC; Z is UTC. |
created_at | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; Z is UTC. |
jobs | list of objects | The jobs. |
jobs[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
jobs[].number | whole number | The number people say out loud, such as the job number. |
jobs[].status | text | The job status. |
jobs[].created_at | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; Z is UTC. |
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. |
| `not_found` | 404 | No such record in the companies this credential reaches. |
| `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
- List clients: The people behind your jobs, by name, with their phones and how many jobs each has.
- The same records in the app: the Jobs panel.
- How the API fits together: the model, API keys, errors and the MCP server.