The request
Reference for Create worker, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.
POST /api/v1/commands/create-worker
The key needs the Team area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.
It runs the app's own command create-worker. Send an Idempotency-Key header with every call: the same key with the same body returns the first answer and runs nothing twice. See the model.
Parameters
| Name | Kind | Required | Description | Example |
|---|---|---|---|---|
role | text, in the JSON body | No | technician (default) or subcontractor. One of technician, subcontractor. | technician |
first_name | text, in the JSON body | Yes | Required. | Sam |
last_name | text, in the JSON body | No | Optional. | Kowalski |
phone | text, in the JSON body | No | Any format; stored as E.164. Two people cannot share one. | +13095550177 |
email | text, in the JSON body | No | Two people cannot share one. | sam@example.com |
is_team_lead | boolean, in the JSON body | No | Technicians only. | false |
monthly_pay | money, in the JSON body | No | A standing monthly rate, a number. Technicians only. | 3200 |
hired_on | date, in the JSON body | No | Technicians only. | 2026-10-26 |
business_name | text, in the JSON body | No | The subcontractor's business. Subcontractors only. | Saleh Moving LLC |
default_cut_basis | text, in the JSON body | No | job_total or job_profit (a percent), or fixed_amount (dollars per job). Send with default_cut_value, or neither. One of job_total, job_profit, fixed_amount. | job_profit |
default_cut_value | money, in the JSON body | No | The percent, 0 to 100, or the dollars. | 40 |
job_type_ids | text, in the JSON body | No | Job types they take, ids comma separated, from Who am I. Empty: all of them. | jt_02,jt_05 |
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
accepted, worker_id, name, role and position. The 6th person on the Free plan is refused with the plan limit sentence, as in the app.
It never deletes anything. It changes only what the command names, and it writes the change to the job's history with who asked for it.
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 |
|---|---|---|
accepted | true or false | True when the command ran. A command that cannot run is an error instead. |
worker_id | id (text) | The id of the worker. |
position | whole number | Where the change landed in the event log. Pass it as after on a read to see your own write. |
name | text | The name, as the app shows it. |
role | text | One of technician, subcontractor. |
Same rules as the Team panel
A phone or email another person already has is refused, and a cut needs both its basis and its value.
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. |
| `read_only` | 403 | This credential may read this area but not change it. |
| `invalid` | 422 | Some fields were refused. See fields. |
| `missing_idempotency_key` | 400 | Send an Idempotency-Key header on every command. |
| `idempotency_mismatch` | 409 | This Idempotency-Key was used with a different body. |
| `idempotency_in_progress` | 409 | A command with this Idempotency-Key is still running. Wait a moment and send it again. |
| `no_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- Update worker: Change a technician or subcontractor: name, contact, pay, cut, job types, or take them off the roster. Only the fields you send change.
- The same records in the app: the Team panel.
- How the API fits together: the model, API keys, errors and the MCP server.