Skip to Content
Hey Town Hall Data docs
Meetings

API reference · Meetings

List meetings

View as Markdown
GET
/v1/meetings

Meetings of councils, boards and committees, newest first. topic keeps meetings with an agenda item, motion, document or recording tagged with it. Billed as one records request a page. Filters: jurisdiction, region, country, kind, topic, from, to, since.

Authorization

bearerAuth
headerAuthorizationBearer <token>

htd_test_ (sandbox, free, fictional towns) or htd_live_ (live, billed) key.

Query Parameters

jurisdiction?string

A jurisdiction id.

Match^[a-z0-9][a-z0-9-]{0,63}$
region?string

A two-letter province or state code.

country?string

CA or US.

kind?string

council, committee_of_the_whole, public_hearing, board, committee, other.

Match^[a-z][a-z0-9_]{0,60}$
topic?string

A business topic id (GET /v1/topics lists the tags given).

Match^[a-z][a-z0-9_]{0,60}$
from?string

On or after this date (YYYY-MM-DD).

to?string

On or before this date (YYYY-MM-DD).

since?string

Records read at or after this instant: what is new since your last read.

limit?integer

Results a page, 1 to 100. Default 25.

cursor?string

next_cursor from the previous page.

Response Body

A page.

application/json
  1. response
query*

The filters as the API read them, defaults included.

as_of*string

ISO 8601 instant, UTC.

results*array<>
next_cursor*|

Pass as cursor for the next page; null on the last.

environment*string

sandbox answers carry fictional towns.

Value in"sandbox""live"
Example Request
curl -X GET 'https://data.heytownhall.com/v1/meetings'
Example Response
{  "query": {    "property1": null,    "property2": null  },  "as_of": "string",  "results": [    {      "id": "string",      "jurisdiction_id": "string",      "country": "string",      "region": "string",      "title": "string",      "kind": "string",      "closed": true,      "cancelled": true,      "meeting_date": "string",      "starts_at": "string",      "time_zone": "string",      "location": "string",      "platform": "string",      "organ_id": "string",      "organ_name": "string",      "organ_kind": "string",      "agenda_seen_at": "string",      "items_read_at": "string",      "minutes_read_at": "string",      "source_url": "string",      "read_at": "string"    }  ],  "next_cursor": "string",  "environment": "sandbox"}

Retrieve a meeting GET

One meeting with its agenda items, documents, recordings and motions. Billed as one records request.

List recordings GET

Meeting videos and audio, and whether a transcript is held. Billed as one records request a page. Filters: jurisdiction, from, to, since, meeting.