# Get import fields

Get import fields is a read in the HeadHoncho API. Every field an import reads, for the jobs file and the money file: its label, its tier and what leaving it blank costs.

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

`GET /api/v1/imports/fields`

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

jobs and money, each with kind, label, blurb, filename and fields (key, label, kind, tier, becomes, cost, multi). example_prefix: the word the template's example rows start with, which an import skips.

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 |
| --- | --- | --- |
| `jobs` | object | The jobs. |
| `jobs.kind` | text | What sort of thing this is. |
| `jobs.label` | text | The name the app shows for it. |
| `jobs.blurb` | text | The blurb. |
| `jobs.filename` | text | The name of the file. |
| `jobs.fields` | list of objects | The fields. |
| `jobs.fields[].key` | text | A short code for this item. Match on it in code. |
| `jobs.fields[].label` | text | The name the app shows for it. |
| `jobs.fields[].kind` | text | What sort of thing this is. |
| `jobs.fields[].tier` | text | The tier. |
| `jobs.fields[].becomes` | text | The becomes. |
| `jobs.fields[].cost` | text | What it cost. |
| `jobs.fields[].multi` | true or false | The multi. |
| `money` | object | The money. |
| `money.kind` | text | What sort of thing this is. |
| `money.label` | text | The name the app shows for it. |
| `money.blurb` | text | The blurb. |
| `money.filename` | text | The name of the file. |
| `money.fields` | list | The fields. |
| `example_prefix` | text | The example prefix. |

## 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 import systems](https://headhoncho.app/docs/api/list_import_systems): 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.
- [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
{
  "jobs": {
    "kind": "jobs",
    "label": "Jobs file",
    "blurb": "Who, where, when, and which ad sent them.",
    "filename": "headhoncho-jobs-template.csv",
    "fields": [
      {
        "key": "ref",
        "label": "Ref",
        "kind": "ref",
        "tier": "required",
        "becomes": "The job's reference in your old system.",
        "cost": "A stand-in is made from the row's own facts.",
        "multi": false
      }
    ]
  },
  "money": {
    "kind": "money",
    "label": "Money file",
    "blurb": "What each job made.",
    "filename": "headhoncho-money-template.csv",
    "fields": []
  },
  "example_prefix": "EXAMPLE"
}
```

### cURL

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

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/imports/fields",
    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/fields", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

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