# List import systems

List import systems is a read in the HeadHoncho API. The systems a book can be imported from, and for each the steps to get its file out, what the file cannot carry, and which one this workspace used last.

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

`GET /api/v1/imports/systems`

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

systems, one per source: key, name, blurb, files, steps (kind, title, where to click, delivery, format, optional), cannot (what that system's file cannot carry) and warn. intents: the ways to import. last_system: the key this workspace used last, or null.

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 |
| --- | --- | --- |
| `systems` | list of objects | The systems. |
| `systems[].key` | text | A short code for this item. Match on it in code. |
| `systems[].name` | text | The name, as the app shows it. |
| `systems[].mark` | text | The mark. |
| `systems[].blurb` | text | The blurb. |
| `systems[].files` | text | The files. |
| `systems[].header_stable` | true or false | The header stable. |
| `systems[].steps` | list of objects | The steps. |
| `systems[].steps[].kind` | text | What sort of thing this is. |
| `systems[].steps[].title` | text | The title, as the app shows it. |
| `systems[].steps[].where` | text | The where. |
| `systems[].steps[].delivery` | text | The delivery. |
| `systems[].steps[].format` | text | The format. |
| `systems[].steps[].optional` | true or false | The optional. |
| `systems[].cannot` | list of text | The cannot. |
| `systems[].warn` | text | The warn. |
| `intents` | object | The intents. |
| `intents.jobs` | text | The jobs. |
| `intents.jobs_only` | text | The jobs only. |
| `intents.money` | text | The money. |
| `last_system` | text | The last system. |

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

- [Get import fields](https://headhoncho.app/docs/api/get_import_fields): Every field an import reads, for the jobs file and the money file: its label, its tier and what leaving it blank costs.
- [Get import template](https://headhoncho.app/docs/api/get_import_template): A CSV to fill in, with every column the import reads and three example rows, for the jobs file, the money file or a payments list.
- [Stage import](https://headhoncho.app/docs/api/stage_import): Send one export file (CSV or Excel) and get back what each column looks like and the mapping we propose. Nothing is imported yet.
- [List import statuses](https://headhoncho.app/docs/api/list_import_statuses): The status words the staged files use, how many rows carry each, and which of our statuses each should land on. Nothing is written.
- [List import job types](https://headhoncho.app/docs/api/list_import_job_types): The job-type words the staged files use, how many rows carry each, and which of our job types each should land on. Nothing is written.
- [Preview import](https://headhoncho.app/docs/api/preview_import): Read the staged files against this workspace and say what an import would do, row by row: what lands, what is already here, what is refused and why.
- [Rehearse import](https://headhoncho.app/docs/api/rehearse_import): Run the whole import for real inside one step that is then thrown away, and say what it would have landed and refused. Nothing is kept.
- [Commit import](https://headhoncho.app/docs/api/commit_import): Import every clean row of the staged files: the jobs, then the money on them. Rows already here are skipped, so sending it twice adds nothing.
- 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
{
  "systems": [
    {
      "key": "workiz",
      "name": "Workiz",
      "mark": "W",
      "blurb": "Jobs report and Payments report, joined by Job ID.",
      "files": "2 files · you choose the columns",
      "header_stable": false,
      "steps": [
        {
          "kind": "jobs",
          "title": "The jobs",
          "where": "In Workiz open Reports...",
          "delivery": "download",
          "format": "a CSV",
          "optional": false
        }
      ],
      "cannot": [
        "A tech's cut"
      ],
      "warn": ""
    }
  ],
  "intents": {
    "jobs": "Jobs and money",
    "jobs_only": "Jobs only",
    "money": "Money only, the jobs are already here"
  },
  "last_system": "workiz"
}
```

### cURL

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

### Python

```python
import requests

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

### JavaScript

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

### Your AI

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