# Get worker

Get worker is a read in the HeadHoncho API. One technician or subcontractor: contact details, role, monthly pay, cut, the job types they take and whether the person has claimed their card.

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

`GET /api/v1/workers/{worker_id}`

The key needs the **Team** 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 |
| --- | --- | --- | --- | --- |
| `worker_id` | id, in the path | Yes | The technician or subcontractor, from List technicians. | `wrk_3b90` |

## 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

The person: id, role, name, first_name, last_name, email, phone, active, is_team_lead, monthly_pay (a number, or null when none was agreed), hired_on, ended_on, business_name (subcontractors), default_cut (basis, value and a label, or null), job_types and any_job_type (true when there is no limit), claimed (a login is linked) and open_claim_id.

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. |
| `role` | text | The role: what this person does on a job. |
| `name` | text | The name, as the app shows it. |
| `first_name` | text | The first name. |
| `last_name` | text | The last name. |
| `email` | text | The email. |
| `phone` | text | A phone number. Hidden when the key hides personal details. |
| `active` | true or false | The active. |
| `is_team_lead` | true or false | True when it is team lead. |
| `monthly_pay` | value or null | The monthly pay. |
| `hired_on` | date (YYYY-MM-DD) | The date it was hired. |
| `ended_on` | value or null | The date it was ended. |
| `business_name` | text | The business name. |
| `default_cut` | object | The default cut. |
| `default_cut.basis` | text | The basis. |
| `default_cut.value` | money (number) | The value. In the company's currency. |
| `default_cut.label` | text | The name the app shows for it. |
| `job_types` | list of objects | The job types. |
| `job_types[].id` | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
| `job_types[].name` | text | The name, as the app shows it. |
| `any_job_type` | true or false | The any job type. |
| `claimed` | true or false | The claimed. |
| `open_claim_id` | value or null | The id of the open claim. |

## What is left out

The balance, the dispatch groups, the text-message consent and the logins you could link are not here. They are money, messages and who can sign in, which stay in the app.

## 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. |
| [`not_found`](https://headhoncho.app/docs/api/errors#not_found) | 404 | No such record in the companies this credential reaches. |
| [`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

- [List technicians](https://headhoncho.app/docs/api/list_technicians): Everyone the company sends jobs to: technicians and subcontractors, with contact details, the job types they take and the cut they work on.
- The same records in the app: [the Team panel](https://headhoncho.app/docs/team).
- 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
{
  "id": "wrk_3b90",
  "role": "technician",
  "name": "Dana Reyes",
  "first_name": "Dana",
  "last_name": "Reyes",
  "email": "dana@example.com",
  "phone": "+13095550188",
  "active": true,
  "is_team_lead": true,
  "monthly_pay": null,
  "hired_on": "2025-03-10",
  "ended_on": null,
  "business_name": "",
  "default_cut": {
    "basis": "job_profit",
    "value": 40.0,
    "label": "40% of job profit"
  },
  "job_types": [
    {
      "id": "jt_02",
      "name": "Local move"
    }
  ],
  "any_job_type": false,
  "claimed": true,
  "open_claim_id": null
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/workers/wrk_3b90" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/workers/wrk_3b90",
    headers={"Authorization": "Bearer hh_live_..."},
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/workers/wrk_3b90", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: get_worker
Arguments: worker_id (id, required)
Access: read on Team
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, get worker with worker_id wrk_3b90."
```