# List area jobs

List area jobs is a read in the HeadHoncho API. The jobs behind one area on the map, newest first, twenty-five a page, with status, price, profit and where they came from.

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

`GET /api/v1/statistics/area-jobs`

The key needs the **Statistics and marketing** 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 |
| --- | --- | --- | --- | --- |
| `company_id` | id, in the query | No | One company. Default: every company the credential reaches. | `cmp_14f5` |
| `from` | date, in the query | No | First day. Default: the last 30 days, as the Statistics panel does. | `2026-10-01` |
| `to` | date, in the query | No | Last day, included. Default: today in the company's time zone. | `2026-10-26` |
| `by_date` | text, in the query | No | Which date puts a job in the range: created (default), scheduled or closed. One of `created`, `scheduled`, `closed`. | `created` |
| `postal_code` | text, in the query | No | The area's postal code, from Jobs by area. Empty for the jobs with none. | `61701` |
| `city` | text, in the query | No | The area's city, from Jobs by area. A postal code can cover several cities. | `Bloomington` |
| `page` | number, in the query | No | Default 1. | `1` |

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

items, one job each: job_id, number, client_name, client_phone, address, status (name, slug), quoted_price, net (profit on the job), created_at, scheduled_start, workers, source, lat, lng; total, page, pages, page_size and label.

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[].job_id` | id (text) | The id of the job. |
| `items[].number` | whole number | The number people say out loud, such as the job number. |
| `items[].client_name` | text | The customer's name. Hidden when the key hides personal details. |
| `items[].client_phone` | text | The customer's phone number. Hidden when the key hides personal details. |
| `items[].address` | text | The address. |
| `items[].status` | object | The job status. |
| `items[].status.name` | text | The name, as the app shows it. |
| `items[].status.slug` | text | The same name as a lowercase code word. Match on this, not on the name. |
| `items[].quoted_price` | money (number) | The quoted price. In the company's currency. |
| `items[].net` | money (number) | The net amount, after what is owed either way. In the company's currency. |
| `items[].created_at` | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; `Z` is UTC. |
| `items[].scheduled_start` | time (ISO 8601, with offset) | When the visit is planned to start. Carries its offset from UTC; `Z` is UTC. |
| `items[].workers` | list of text | The workers. |
| `items[].source` | text | The source. |
| `items[].lat` | number | The lat. |
| `items[].lng` | number | The lng. |
| `total` | whole number | The total, in the company's currency. |
| `page` | whole number | The page number, starting at 1. |
| `pages` | whole number | How many pages there are. |
| `page_size` | whole number | The page size. |
| `label` | text | The name the app shows for it. |

## Personal details

A key made to hide personal details gets initials for the customer, the last four digits of the phone, no street, and the point rounded to about a kilometre.

## 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. |
| [`out_of_scope`](https://headhoncho.app/docs/api/errors#out_of_scope) | 404 | No such company 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

- [Get statistics summary](https://headhoncho.app/docs/api/get_statistics_summary): Jobs and leads for a range and the money they left: profit, lead cost, cost per lead, profit after leads, ad spend and profit after advertising.
- [Get statistics areas](https://headhoncho.app/docs/api/get_statistics_areas): Every place the work happened, by postal code and city: jobs, closes, cancels, average ticket and profit, with a point to put on a map.
- [List job pins](https://headhoncho.app/docs/api/list_job_pins): Each job in the range that has a point on the map, newest first, up to 400, with its status, price and profit. Narrow it with a box.
- The same records in the app: [the Statistics panel](https://headhoncho.app/docs/statistics).
- 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
{
  "items": [
    {
      "job_id": "job_1138",
      "number": 1138,
      "client_name": "R. Azoulay",
      "client_phone": "+12175550142",
      "address": "2590 Main St, Bloomington, IL 61701",
      "status": {
        "name": "Closed",
        "slug": "closed"
      },
      "quoted_price": 1450.0,
      "net": 610.0,
      "created_at": "2026-10-11T18:25:40Z",
      "scheduled_start": "2026-10-16T09:00:00-05:00",
      "workers": [
        "Dana R."
      ],
      "source": "Google Ads",
      "lat": 40.4842,
      "lng": -88.9937
    }
  ],
  "total": 21,
  "page": 1,
  "pages": 1,
  "page_size": 25,
  "label": "61701 · Bloomington"
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/statistics/area-jobs?company_id=cmp_14f5&from=2026-10-01" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/statistics/area-jobs",
    headers={"Authorization": "Bearer hh_live_..."},
    params={
        "company_id": "cmp_14f5",
        "from": "2026-10-01",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/statistics/area-jobs?company_id=cmp_14f5&from=2026-10-01", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_area_jobs
Arguments: company_id (id, optional), from (date, optional), to (date, optional), by_date (text, optional), postal_code (text, optional), city (text, optional), page (number, optional)
Access: read on Statistics and marketing
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list area jobs with company_id cmp_14f5."
```