Get job detour

The request

Reference for Get job detour, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.

GET /api/v1/jobs/{job_id}/detour

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
`job_id`	id, in the path	Yes	The job id, or its 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 API key job_id (required, id)

Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.

What comes back

job, on_detour (true or false), detour (id and name of the status it is on), returns_to (the status it left, or null), lands_on (where it would stand after Resolve, once the automation has moved it, or null), automatic (true when the automation would move it on) and refusal (a sentence when Resolve would be refused, otherwise empty). It is a rehearsal: nothing is changed or sent.

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
`job`	object	The job.
`job.id`	id (text)	The id of this record. Ids are opaque text: keep them exactly as given.
`job.number`	whole number	The number people say out loud, such as the job number.
`on_detour`	true or false	The on detour.
`detour`	object	Why the job is waiting, in words.
`detour.id`	id (text)	The id of this record. Ids are opaque text: keep them exactly as given.
`detour.name`	text	The name, as the app shows it.
`returns_to`	object	The returns to.
`returns_to.id`	id (text)	The id of this record. Ids are opaque text: keep them exactly as given.
`returns_to.name`	text	The name, as the app shows it.
`lands_on`	object	The date it was lands.
`lands_on.id`	id (text)	The id of this record. Ids are opaque text: keep them exactly as given.
`lands_on.name`	text	The name, as the app shows it.
`automatic`	true or false	The automatic.
`refusal`	text	The refusal.

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.
`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.

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

Answer cURL Python JavaScript Your AI

{
  "job": {
    "id": "job_1138",
    "number": 1138
  },
  "on_detour": true,
  "detour": {
    "id": "st_08",
    "name": "Waiting on parts"
  },
  "returns_to": {
    "id": "st_02",
    "name": "Scheduled"
  },
  "lands_on": {
    "id": "st_02",
    "name": "Scheduled"
  },
  "automatic": true,
  "refusal": ""
}

curl "https://api.headhoncho.app/api/v1/jobs/job_1138/detour" \
  -H "Authorization: Bearer hh_live_..."

import requests

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

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

Tool: get_job_detour
Arguments: job_id (id, required)
Access: read on Jobs
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, get job detour with job_id job_1138."