HeadHoncho

Get agency feed

Get agency feed is a read in the HeadHoncho API. How the workspace sends closed jobs to its agency: the webhook address, the daily file, whether it is on, and the last tries.

Read as Markdown

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.

FieldTypeMeaning
feedobjectThe feed.
feed.webhook_urltextThe webhook url.
feed.webhook_secret_hinttextThe webhook secret hint.
feed.api_token_hinttextThe api token hint.
feed.daily_totextThe daily to.
feed.daily_hourwhole numberThe daily hour.
feed.enabledtrue or falseThe enabled.
feed.changed_attime (ISO 8601, with offset)When it was changed. Carries its offset from UTC; Z is UTC.
date_formattextThe date format.
eventtextThe kind of event, as a code.
columnslist of textThe columns.
keyslist of textThe keys.
deliverieslist of objectsThe deliveries.
deliveries[].idid (text)The id of this record. Ids are opaque text: keep them exactly as given.
deliveries[].job_idid (text)The id of the job.
deliveries[].ticketwhole numberThe job number the ticket shows.
deliveries[].event_kindtextThe event kind.
deliveries[].statustextThe job status.
deliveries[].attemptwhole numberThe attempt.
deliveries[].response_codewhole numberThe response code.
deliveries[].errortextThe error.
deliveries[].attempted_attime (ISO 8601, with offset)When it was attempted. Carries its offset from UTC; Z is UTC.
exportslist of objectsThe exports.
exports[].idid (text)The id of this record. Ids are opaque text: keep them exactly as given.
exports[].sent_totextThe sent to.
exports[].period_keydate (YYYY-MM-DD)The period key.
exports[].rowswhole numberThe rows.
exports[].statustextThe job status.
exports[].errortextThe error.
exports[].sent_attime (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

CodeStatusWhat it means
`missing_key`401Send your key as Authorization: Bearer hh_live_...
`unknown_key`401That key is not one we issued, or it was revoked.
`no_access`403This credential does not reach that. Ask the person who made it for access.
`no_credits`402Out of credits. Top up on Settings › Credits, or turn on auto top-up.
  • 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.