The request
Reference for Search jobs, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/search
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 |
|---|---|---|---|---|
q | text, in the query | Yes | What to look for, up to 100 characters. A ticket number such as 1138 or #1138 finds that job. Other text needs a word of three letters or more; every word must match. | azoulay oak |
company_id | id, in the query | No | One company. Default: every company the credential reaches. | cmp_14f5 |
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
query, jobs (up to 8, newest first, one job each in the Get a job shape; archived jobs are found, Trash is not), technicians (up to 5: id, name, role) and timed_out, true when the search was cut short and the lists may be empty for that reason. This finds; it does not filter a list.
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 |
|---|---|---|
query | text | The query. |
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[].company | object | The company. |
jobs[].company.id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
jobs[].company.name | text | The name, as the app shows it. |
jobs[].client | object | The client. |
jobs[].client.id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
jobs[].client.name | text | The name, as the app shows it. |
jobs[].client.phone | text | A phone number. Hidden when the key hides personal details. |
jobs[].client.second_phone | text | A second phone number. Hidden when the key hides personal details. |
jobs[].address | object | The address. |
jobs[].address.line1 | text | The street address. Hidden when the key hides personal details. |
jobs[].address.line2 | text | The apartment or suite line. Hidden when the key hides personal details. |
jobs[].address.city | text | The city. |
jobs[].address.state | text | The state or region. |
jobs[].address.postal_code | text | The postal code. |
jobs[].address.one_line | text | The whole address on one line. Hidden when the key hides personal details. |
jobs[].job_type | object | The job type. |
jobs[].job_type.id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
jobs[].job_type.name | text | The name, as the app shows it. |
jobs[].status | object | The job status. |
jobs[].status.id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
jobs[].status.name | text | The name, as the app shows it. |
jobs[].status.slug | text | The same name as a lowercase code word. Match on this, not on the name. |
jobs[].status.since | time (ISO 8601, with offset) | From when this has been true. Carries its offset from UTC; Z is UTC. |
jobs[].technicians | list of objects | The technicians. |
jobs[].technicians[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
jobs[].technicians[].name | text | The name, as the app shows it. |
jobs[].scheduled_start | time (ISO 8601, with offset) | When the visit is planned to start. Carries its offset from UTC; Z is UTC. |
jobs[].scheduled_end | time (ISO 8601, with offset) | When the visit is planned to end. Carries its offset from UTC; Z is UTC. |
jobs[].collected | money (number) | The money received on the job so far. In the company's currency. |
jobs[].profit | money (number) | The job's profit, worked out the way the app works it out. In the company's currency. |
jobs[].currency | text | The three-letter currency code (ISO 4217). Every money value in the answer is in it. |
jobs[].source | object | The source. |
jobs[].source.label | text | The name the app shows for it. |
jobs[].source.filled_by | text | How the job source was filled in: call, form or by hand. |
jobs[].source.click_id | id (text) | The Google click id (gclid) the call or visit carried. |
jobs[].source.call_id | id (text) | The id of the call. |
jobs[].source.call_at | time (ISO 8601, with offset) | When the call happened. Carries its offset from UTC; Z is UTC. |
jobs[].source.campaign | text | The ad campaign's name. |
jobs[].is_lead | true or false | True while the job is still a lead. |
jobs[].notes | text | Free-text notes. |
jobs[].created_at | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; Z is UTC. |
jobs[].closed_at | time or null | When it was closed. |
jobs[].canceled_at | time or null | When it was canceled. |
jobs[].archived_at | time or null | When it was archived. |
jobs[].trashed_at | time or null | When it was trashed. |
technicians | list of objects | The technicians. |
technicians[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
technicians[].name | text | The name, as the app shows it. |
technicians[].role | text | The role: what this person does on a job. |
timed_out | true or false | The timed out. |
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 situations: The situations the AI dispatcher is working on jobs now: what came up, the plan, and which step it is on.
- 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.
- 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.