Skip to Content
Hey Town Hall Data docs
Meetings

API reference · Meetings

List meeting documents

View as Markdown
GET
/v1/meeting-documents

Agenda packages, minutes and attachments a meeting lists, with their links. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since, meeting.

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

agenda_package, minutes, attachment, …

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.

meeting?string

A meeting id.

Match^[0-9]{1,18}$
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/meeting-documents'
Example Response
{  "query": {    "property1": null,    "property2": null  },  "as_of": "string",  "results": [    {      "id": "string",      "meeting_id": "string",      "jurisdiction_id": "string",      "country": "string",      "region": "string",      "meeting_date": "string",      "item_position": 0,      "kind": "string",      "title": "string",      "format": "string",      "source_url": "string",      "read_at": "string"    }  ],  "next_cursor": "string",  "environment": "sandbox"}

List agenda items GET

Agenda items, newest meeting first and in agenda order within a meeting, each with its plain-words summary where one passed its check, and its business topics. Billed as one records request a page. Filters: jurisdiction, region, country, topic, from, to, since, meeting.

A meeting's transcript GET

The meeting's recordings' transcript lines in order, without speaker labels. Billed as one transcripts request a page. An empty page means no transcript is held yet, never that nothing was said.