HeadHoncho

List area jobs

List area jobs is a read in the HeadHoncho API. The jobs behind one area on the map, newest first, twenty-five a page, with status, price, profit and where they came from.

    Read as Markdown

    The request

    Reference for List area jobs, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.

    GET /api/v1/statistics/area-jobs

    The key needs the Statistics and marketing 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

    NameKindRequiredDescriptionExample
    company_idid, in the queryNoOne company. Default: every company the credential reaches.cmp_14f5
    fromdate, in the queryNoFirst day. Default: the last 30 days, as the Statistics panel does.2026-10-01
    todate, in the queryNoLast day, included. Default: today in the company's time zone.2026-10-26
    by_datetext, in the queryNoWhich date puts a job in the range: created (default), scheduled or closed. One of created, scheduled, closed.created
    postal_codetext, in the queryNoThe area's postal code, from Jobs by area. Empty for the jobs with none.61701
    citytext, in the queryNoThe area's city, from Jobs by area. A postal code can cover several cities.Bloomington
    pagenumber, in the queryNoDefault 1.1

    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

    items, one job each: job_id, number, client_name, client_phone, address, status (name, slug), quoted_price, net (profit on the job), created_at, scheduled_start, workers, source, lat, lng; total, page, pages, page_size and label.

    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
    itemslist of objectsThe rows on this page.
    items[].job_idid (text)The id of the job.
    items[].numberwhole numberThe number people say out loud, such as the job number.
    items[].client_nametextThe customer's name. Hidden when the key hides personal details.
    items[].client_phonetextThe customer's phone number. Hidden when the key hides personal details.
    items[].addresstextThe address.
    items[].statusobjectThe job status.
    items[].status.nametextThe name, as the app shows it.
    items[].status.slugtextThe same name as a lowercase code word. Match on this, not on the name.
    items[].quoted_pricemoney (number)The quoted price. In the company's currency.
    items[].netmoney (number)The net amount, after what is owed either way. In the company's currency.
    items[].created_attime (ISO 8601, with offset)When it was created. Carries its offset from UTC; Z is UTC.
    items[].scheduled_starttime (ISO 8601, with offset)When the visit is planned to start. Carries its offset from UTC; Z is UTC.
    items[].workerslist of textThe workers.
    items[].sourcetextThe source.
    items[].latnumberThe lat.
    items[].lngnumberThe lng.
    totalwhole numberThe total, in the company's currency.
    pagewhole numberThe page number, starting at 1.
    pageswhole numberHow many pages there are.
    page_sizewhole numberThe page size.
    labeltextThe name the app shows for it.

    Personal details

    A key made to hide personal details gets initials for the customer, the last four digits of the phone, no street, and the point rounded to about a kilometre.

    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.
    `not_found`404No such record in the companies this credential reaches.
    `out_of_scope`404No such company in the companies this credential reaches.
    `invalid`422Some fields were refused. See fields.
    `no_credits`402Out of credits. Top up on Settings › Credits, or turn on auto top-up.
    • Get statistics summary: Jobs and leads for a range and the money they left: profit, lead cost, cost per lead, profit after leads, ad spend and profit after advertising.
    • Get statistics areas: Every place the work happened, by postal code and city: jobs, closes, cancels, average ticket and profit, with a point to put on a map.
    • List job pins: Each job in the range that has a point on the map, newest first, up to 400, with its status, price and profit. Narrow it with a box.
    • The same records in the app: the Statistics panel.
    • How the API fits together: the model, API keys, errors and the MCP server.