The request
Reference for List technicians, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/technicians
The key needs the Team 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 |
|---|---|---|---|---|
role | text, in the query | No | technician or subcontractor. Default: both. One of technician, subcontractor. | subcontractor |
active | text, in the query | No | yes for people on the roster now, no for people taken off it. Default: both. One of yes, no. | yes |
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 person each in the Get a team member shape, active people first and then by name; count, how many. A technician belongs to the workspace, so the list is the same whichever company the key reaches.
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[].role | text | One of technician, subcontractor. |
items[].name | text | The name, as the app shows it. |
items[].first_name | text | The first name. |
items[].last_name | text | The last name. |
items[].email | text | The email. |
items[].phone | text | A phone number. Hidden when the key hides personal details. |
items[].active | true or false | One of yes, no. |
items[].is_team_lead | true or false | True when it is team lead. |
items[].monthly_pay | value or null | The monthly pay. |
items[].hired_on | date (YYYY-MM-DD) | The date it was hired. |
items[].ended_on | value or null | The date it was ended. |
items[].business_name | text | The business name. |
items[].default_cut | object | The default cut. |
items[].default_cut.basis | text | The basis. |
items[].default_cut.value | money (number) | The value. In the company's currency. |
items[].default_cut.label | text | The name the app shows for it. |
items[].job_types | list of objects | The job types. |
items[].job_types[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
items[].job_types[].name | text | The name, as the app shows it. |
items[].any_job_type | true or false | The any job type. |
items[].claimed | true or false | The claimed. |
items[].open_claim_id | value or null | The id of the open claim. |
count | whole number | How many match in all, across every page. |
Money is somewhere else
What a person is owed is on Balances, and the jobs they are on are on List jobs with worker_id. This list is the person, not their money.
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 worker: One technician or subcontractor: contact details, role, monthly pay, cut, the job types they take and whether the person has claimed their card.
- The same records in the app: the Team panel.
- How the API fits together: the model, API keys, errors and the MCP server.