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.
Send your key as Authorization: Bearer hh_live_.... See 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.
Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.
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` | 401 | Send your key as Authorization: Bearer hh_live_... |
| `unknown_key` | 401 | That key is not one we issued, or it was revoked. |
| `no_access` | 403 | This credential does not reach that. Ask the person who made it for access. |
| `no_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- 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: 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: 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: 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: 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: 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: 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: 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.
- How the API fits together: the model, API keys, errors and the MCP server.