Skip to Content
Hey Town Hall Data docs

Records

Public word

News, notices and events, engagement projects, and local press headlines.

View as Markdown

What governments post for the public, and what the local press says about them. For press, only the headline, the publisher and the link: never the article's text.

News, notices and events

GET /v1/news

List news, notices and events. What a government posts: news, public notices, council recaps, events and alerts. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

Reference and playground for list news, notices and events

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindnews, notice, recap, event, alert.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/news
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
kindstringnews, notice, recap, event, alert.
titlestring
summarystring or null
starts_atstring or nullISO 8601 instant, UTC.
ends_atstring or nullISO 8601 instant, UTC.
all_dayboolean or null
locationstring or null
addressstring or null
published_atstring or nullISO 8601 instant, UTC.
closes_atstring or nullISO 8601 instant, UTC.
categoriesarray of string or null
cancelledboolean or null
first_seen_atstringISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Engagement projects

GET /v1/engagements

List engagement projects. Open public engagement: surveys, consultations and open houses. Billed as one records request a page. Filters: jurisdiction, region, country, from, to, since.

Reference and playground for list engagement projects

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/engagements
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
titlestring
summarystring or null
published_atstring or nullISO 8601 instant, UTC.
closes_atstring or nullISO 8601 instant, UTC.
categoriesarray of string or null
first_seen_atstringISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Local press

GET /v1/press

List local press. Local press about a government: the headline, the publisher and the link. Never the article's text. Billed as one records request a page. Filters: jurisdiction, from, to, since.

Reference and playground for list local press

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/press
FieldTypeWhat it holds
idstring
jurisdiction_idstring
titlestring
publisherstring or null
published_atstring or nullISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

On this page