The request
Reference for Get agency feed, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/agency/feed
The key needs the Company settings 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
feed (webhook_url, webhook_secret_hint, api_token_hint, daily_to, daily_hour, enabled, changed_at), columns and keys of the rows it sends, deliveries (the last 50 webhook tries: id, job_id, ticket, event_kind, status, attempt, response_code, error, attempted_at) and exports (the last 14 daily files). Secrets are never shown, only their last characters.
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 |
|---|---|---|
feed | object | The feed. |
feed.webhook_url | text | The webhook url. |
feed.webhook_secret_hint | text | The webhook secret hint. |
feed.api_token_hint | text | The api token hint. |
feed.daily_to | text | The daily to. |
feed.daily_hour | whole number | The daily hour. |
feed.enabled | true or false | The enabled. |
feed.changed_at | time (ISO 8601, with offset) | When it was changed. Carries its offset from UTC; Z is UTC. |
date_format | text | The date format. |
event | text | The kind of event, as a code. |
columns | list of text | The columns. |
keys | list of text | The keys. |
deliveries | list of objects | The deliveries. |
deliveries[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
deliveries[].job_id | id (text) | The id of the job. |
deliveries[].ticket | whole number | The job number the ticket shows. |
deliveries[].event_kind | text | The event kind. |
deliveries[].status | text | The job status. |
deliveries[].attempt | whole number | The attempt. |
deliveries[].response_code | whole number | The response code. |
deliveries[].error | text | The error. |
deliveries[].attempted_at | time (ISO 8601, with offset) | When it was attempted. Carries its offset from UTC; Z is UTC. |
exports | list of objects | The exports. |
exports[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
exports[].sent_to | text | The sent to. |
exports[].period_key | date (YYYY-MM-DD) | The period key. |
exports[].rows | whole number | The rows. |
exports[].status | text | The job status. |
exports[].error | text | The error. |
exports[].sent_at | time (ISO 8601, with offset) | When the sent happened. Carries its offset from UTC; Z is UTC. |
Owners and admins only
The feed belongs to the whole workspace, as in the app, where only an owner or an admin opens it. The key must reach every company.
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 ad accounts: The ad accounts and call tracking each company has connected, and how each one is doing.
- List campaigns: Spend by campaign for a range, with the calls, leads, lead cost, revenue and profit each one produced, and the revenue that could not be placed.
- List agency jobs: The agency's jobs feed on a key: one row per job that opened or closed in the range, in the agency's sixteen columns, a page at a time.
- The same records in the app: Settings.
- How the API fits together: the model, API keys, errors and the MCP server.