The request
Reference for Get credits, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/credits
Any key can call it. 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
available (grant, rolled_over, carried and topped_up, less used), granted, used, month (YYYY-MM, in the workspace's time zone), renews_on, plan, plan_status and per_call, the credits one API call costs. The same figures the app's credits box shows. Card details and buying credits stay in the app.
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 |
|---|---|---|
available | number | True when this is connected and can be read. |
granted | number | The granted. |
used | number | The used. |
month | text | The first day of the month. |
plan | text | The plan. |
plan_status | text | The plan status. |
renews_on | date (YYYY-MM-DD) | The date it was renews. |
grant | number | The grant. |
rolled_over | number | The rolled over. |
carried | number | The carried. |
topped_up | number | The topped up. |
per_call | number | Credits one answered call costs. |
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_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- Whoami: Who this key or app acts as, which companies it reaches, what it may do, and the words to use in commands: statuses, job types and technicians.
- List companies: The companies this credential reaches, each with its name, time zone, country and service area. The same ids every other call takes as company_id.
- Get company: One company this credential reaches: its name, time zone, country and service area.
- Get usage: What the plan has used, what API calls cost and what this credential called, by day or by endpoint, with the credits left.
- List plans: The plans on offer, with price and what each includes, and which one this workspace is on.
- The same records in the app: Multiple companies.
- How the API fits together: the model, API keys, errors and the MCP server.