Posts
API reference · Posts
Retrieve a job
GET
One job posting with its headed sections. Billed as one records request.
bearerAuthheader
AuthorizationBearer <token>htd_test_ (sandbox, free, fictional towns) or htd_live_ (live, billed) key.
id*stringMatch
^[0-9]{1,18}$The record.
application/json- response
id*stringjurisdiction_id*stringcountry*string|nullregion*string|nulltitle*stringsummary*string|nulllocation*string|nullpublished_at*|ISO 8601 instant, UTC.
closes_at*|ISO 8601 instant, UTC.
status*string|nullemployment_type*string|nullunion_status*string|nullwork_kind*string|nullpay*|As printed.
hours*string|nullwork_location*string|nullpage_read*booleansource_url*|The page, document, video or platform the record was read from.
read_at*|When it was read.
sections*array<>environment*stringValue in
"sandbox""live"curl -X GET 'https://data.heytownhall.com/v1/jobs/string'Example Response
{ "id": "string", "jurisdiction_id": "string", "country": "string", "region": "string", "title": "string", "summary": "string", "location": "string", "published_at": "string", "closes_at": "string", "status": "string", "employment_type": "string", "union_status": "string", "work_kind": "string", "pay": "string", "hours": "string", "work_location": "string", "page_read": true, "source_url": "string", "read_at": "string", "sections": [ { "ord": 0, "role": "string", "heading": "string", "body": "string" } ], "environment": "sandbox"}List engagement projects GET
Open public engagement: surveys, consultations and open houses. Billed as one records request a page. Filters: jurisdiction, region, country, from, to, since.
List job postings GET
Open job postings with pay, hours and terms as the posting prints them. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.