The request
Reference for List situations, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/situations
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 |
|---|---|---|---|---|
company_id | id, in the query | No | One company. Default: every company the credential reaches. | cmp_14f5 |
job_id | id, in the query | No | One job's situations, by id or number. | job_1138 |
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 open situation each: id, job (id and number), kind (key and name), state (raised, open, waiting or recommended), raised_by, raised_at, opened_at, and plan (version, rationale, and its steps in order, each with its action, words and state), or null before the first plan. Closed and dropped situations are in the job's log.
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[].job | object | The job. |
items[].job.id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
items[].job.number | whole number | The number people say out loud, such as the job number. |
items[].kind | object | What sort of thing this is. |
items[].kind.key | text | A short code for this item. Match on it in code. |
items[].kind.name | text | The name, as the app shows it. |
items[].state | text | The state or region. |
items[].raised_by | text | The raised by. |
items[].raised_at | time (ISO 8601, with offset) | When it was raised. Carries its offset from UTC; Z is UTC. |
items[].opened_at | time (ISO 8601, with offset) | When it was opened. Carries its offset from UTC; Z is UTC. |
items[].plan | object | The plan. |
items[].plan.version | whole number | The version of this record. It goes up each time it changes. |
items[].plan.rationale | text | Why, in one sentence. |
items[].plan.steps | list of objects | The steps. |
items[].plan.steps[].position | whole number | Where the change landed in the event log. Pass it as after on a read to see your own write. |
items[].plan.steps[].action | text | The action, as a code. |
items[].plan.steps[].words | text | The text, as a person would say it. |
items[].plan.steps[].state | text | The state or region. |
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. |
| `out_of_scope` | 404 | No such company 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 jobs: Jobs and leads in the companies this credential reaches, newest first, with status, technician, schedule, money and the ad click each came from.
- Get job: One job or lead: who, where, when, which status, which technicians, the money on it and the ad click it came from.
- Get job history: Everything that happened to a job, in order, with who did it: created, moved, assigned, noted, paid. The same log the job page shows.
- Get job log: A job's timeline in plain words, one line per thing that happened: notes, moves, texts, money, the rules and the AI, each with who did it.
- List job photos: The photos stored on a job, oldest first, each with a link that opens it for one minute.
- Get photo: One stored photo and a fresh link to its file. The link works for one minute.
- Get calendar: Every job with a booked time between two days, earliest first. Canceled and closed jobs are left out, as on the app's calendar.
- List unscheduled jobs: Open jobs and leads that have no booked time yet, the ones that waited longest first.
- Export jobs: Jobs as a CSV file, newest first, up to 10,000 rows: ticket, technicians, status, dates, address, customer and price.
- Search jobs: Find jobs by ticket number, customer, address or technician name, and technicians by name.
- Get automatic status: Whether a person set this job's status by hand, why its facts do not hold it, and where Back to automatic would put it.
- Get job detour: Whether a job is on a detour, such as Waiting on parts, and where Resolve would put it.
- List job reassignments: The times this job was handed from one technician to another, oldest first, and how far each one got.
- List calendar reassignments: Every reassignment on a job booked in a window: open ones, and ones that closed today.
- The same records in the app: the Jobs panel.
- How the API fits together: the model, API keys, errors and the MCP server.