# List event types

List event types is a read in the HeadHoncho API. Every kind of change the Changes feed can carry, in plain words, and the facts each one puts in data.

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

`GET /api/v1/event-types`

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

This call takes no parameters.

## 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: event (the name used in the feed), says (what happened, in a sentence) and data (the keys that change carries, which can be empty).

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[].event` | text | The kind of event, as a code. |
| `items[].says` | text | The text to show a person. |
| `items[].data` | list of text | The data. |

## Pushed instead of polled

The same kinds are what a webhook sends. Add one to have each change sent to your address, signed, instead of asking for it.

## 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. |
| [`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 events](https://headhoncho.app/docs/api/list_events): What changed on jobs since a cursor: a job opened, moved, assigned or paid, with who did it. Send back next to get the rest.
- 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
{
  "items": [
    {
      "event": "job.created",
      "says": "A job or a lead was opened.",
      "data": [
        "status",
        "job_type",
        "quoted",
        "scheduled_start",
        "scheduled_end",
        "source"
      ]
    },
    {
      "event": "job.details_changed",
      "says": "A job's facts changed: the customer, the address, the schedule, the price, the type or the notes.",
      "data": [
        "job_type",
        "quoted",
        "scheduled_start",
        "scheduled_end"
      ]
    },
    {
      "event": "job.status_changed",
      "says": "A job moved to another status.",
      "data": [
        "status",
        "status_slug",
        "previous_status"
      ]
    },
    {
      "event": "job.assigned",
      "says": "A technician or subcontractor was put on a job.",
      "data": [
        "technician_id",
        "technician"
      ]
    },
    {
      "event": "job.unassigned",
      "says": "A technician or subcontractor was taken off a job.",
      "data": [
        "technician_id",
        "technician"
      ]
    },
    {
      "event": "job.archived",
      "says": "A job was archived.",
      "data": []
    },
    {
      "event": "job.unarchived",
      "says": "A job was taken out of the archive.",
      "data": []
    },
    {
      "event": "job.restored",
      "says": "A job came back from Trash.",
      "data": []
    },
    {
      "event": "job_note.added",
      "says": "A note was added to a job. Read the job's history for the words.",
      "data": []
    },
    {
      "event": "job_payment.recorded",
      "says": "A payment was recorded on a job. Read the job's money for the amount.",
      "data": []
    }
  ]
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/event-types" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/event-types",
    headers={"Authorization": "Bearer hh_live_..."},
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/event-types", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_event_types
Arguments: none
Access: read on Jobs
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list event types."
```