Posts
API reference · Posts
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.
bearerAuthheader
AuthorizationBearer <token>htd_test_ (sandbox, free, fictional towns) or htd_live_ (live, billed) key.
jurisdiction?stringA jurisdiction id.
Match
^[a-z0-9][a-z0-9-]{0,63}$region?stringA two-letter province or state code.
country?stringCA or US.
from?stringOn or after this date (YYYY-MM-DD).
to?stringOn or before this date (YYYY-MM-DD).
since?stringRecords read at or after this instant: what is new since your last read.
limit?integerResults a page, 1 to 100. Default 25.
cursor?stringnext_cursor from the previous page.
A page.
application/json- response
query*The filters as the API read them, defaults included.
as_of*stringISO 8601 instant, UTC.
results*array<>next_cursor*|Pass as cursor for the next page; null on the last.
environment*stringsandbox answers carry fictional towns.
Value in
"sandbox""live"curl -X GET 'https://data.heytownhall.com/v1/engagements'Example Response
{ "query": { "property1": null, "property2": null }, "as_of": "string", "results": [ { "id": "string", "jurisdiction_id": "string", "country": "string", "region": "string", "title": "string", "summary": "string", "published_at": "string", "closes_at": "string", "categories": [ "string" ], "first_seen_at": "string", "source_url": "string", "read_at": "string" } ], "next_cursor": "string", "environment": "sandbox"}