# Get job detour

Get job detour is a read in the HeadHoncho API. Whether a job is on a detour, such as Waiting on parts, and where Resolve would put it.

Page: https://headhoncho.app/docs/api/get_job_detour | 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 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](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 |
| --- | --- | --- | --- | --- |
| `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.

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

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`](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 jobs](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/list_job_photos): The photos stored on a job, oldest first, each with a link that opens it for one minute.
- [Get photo](https://headhoncho.app/docs/api/get_photo): One stored photo and a fresh link to its file. The link works for one minute.
- [Get calendar](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/list_unscheduled_jobs): Open jobs and leads that have no booked time yet, the ones that waited longest first.
- [Export jobs](https://headhoncho.app/docs/api/export_jobs): Jobs as a CSV file, newest first, up to 10,000 rows: ticket, technicians, status, dates, address, customer and price.
- [Search jobs](https://headhoncho.app/docs/api/search_jobs): Find jobs by ticket number, customer, address or technician name, and technicians by name.
- [Get automatic status](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/jobs).
- 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
{
  "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

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

### Python

```python
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())
```

### JavaScript

```javascript
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);
```

### Your AI

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