Skip to Content
Hey Town Hall Data docs

Records

Meetings

Meetings, agenda items, meeting documents, motions, recorded votes, attendance, recordings and transcripts.

View as Markdown

Councils, boards and committees, as their own meeting platforms and minutes publish them. A meeting is the parent of the records below it: pass its id as meeting to read only that meeting's agenda items, documents, motions, votes, attendance or recordings.

Motions, votes and attendance are read from the minutes as printed. A vote is never derived.

Meetings

GET /v1/meetings

List 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.

Reference and playground for list meetings

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindcouncil, committee_of_the_whole, public_hearing, board, committee, other.
topicA business topic id (GET /v1/topics lists the tags given).
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/meetings
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
titlestring
kindstring or nullcouncil, committee_of_the_whole, public_hearing, board, committee, other.
closedboolean or null
cancelledboolean or null
meeting_datestringYYYY-MM-DD.
starts_atstring or nullISO 8601 instant, UTC.
time_zonestring or null
locationstring or null
platformstring or nullThe meeting vendor it was read from.
organ_idstring or null
organ_namestring or null
organ_kindstring or null
agenda_seen_atstring or nullWhen the agenda first appeared.
items_read_atstring or nullISO 8601 instant, UTC.
minutes_read_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.

GET /v1/meetings/{id}

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

Reference and playground for retrieve a meeting

Path: {id} such as 123456.

Agenda items

GET /v1/agenda-items

List agenda items. 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.

Reference and playground for list agenda items

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
topicA business topic id (GET /v1/topics lists the tags given).
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.
meetingA meeting id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/agenda-items
FieldTypeWhat it holds
idstring{meeting_id}-{position}.
meeting_idstring
positionnumber
jurisdiction_idstring
countrystring or null
regionstring or null
meeting_datestringYYYY-MM-DD.
depthnumber or null
numberstring or null
titlestring
recommendationstring or null
video_secondsnumber or nullWhere the item starts in the meeting video, in seconds.
plain_summarystring or nullThe item in plain words, kept only when checked against its source.
why_it_mattersstring or null
report_urlstring or null
topicsarray of stringBusiness topics; empty means not yet tagged.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Meeting documents

GET /v1/meeting-documents

List 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.

Reference and playground for list meeting documents

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindagenda_package, minutes, attachment, …
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.
meetingA meeting id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/meeting-documents
FieldTypeWhat it holds
idstring
meeting_idstring
jurisdiction_idstring
countrystring or null
regionstring or null
meeting_datestringYYYY-MM-DD.
item_positionnumber or null
kindstring or null
titlestring or null
formatstring or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Motions

GET /v1/motions

List motions. Motions as the minutes print them: mover, seconder, outcome and the count of votes, with each key decision's kind, topic and action. Billed as one records request a page. Filters: jurisdiction, region, country, kind, topic, from, to, since, meeting.

Reference and playground for list motions

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindA key decision's kind, such as bylaw_reading or contract_award.
topicA business topic id (GET /v1/topics lists the tags given).
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.
meetingA meeting id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/motions
FieldTypeWhat it holds
idstring
meeting_idstring
jurisdiction_idstring
countrystring or null
regionstring or null
meeting_datestringYYYY-MM-DD.
positionnumber
item_positionnumber or null
numberstring or null
textstring
moverstring or null
seconderstring or null
outcomestring or nullcarried, defeated, tabled, referred, withdrawn — as printed, normalised.
unanimousboolean or null
votes_fornumber or null
votes_againstnumber or null
kindsarray of string
topicsarray of string
actionsarray of string
business_topicsarray of string
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

GET /v1/motions/{id}

Retrieve a motion. One motion with each member's recorded vote. Billed as one records request.

Reference and playground for retrieve a motion

Path: {id} such as 123456.

Recorded votes

GET /v1/votes

List recorded votes. Each member's vote on a motion, as the minutes print it; never derived. A member away when the vote was taken is left out. Billed as one records request a page. Filters: jurisdiction, from, to, since, meeting, motion.

Reference and playground for list recorded votes

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.
meetingA meeting id.
motionA motion id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/votes
FieldTypeWhat it holds
idstring
motion_idstring
meeting_idstring
jurisdiction_idstring
meeting_datestringYYYY-MM-DD.
member_namestring
votestringfor, against, abstain, as the minutes print it.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Attendance

GET /v1/attendance

List attendance. Who the minutes say was present or absent at a meeting. Billed as one records request a page. Filters: jurisdiction, from, to, since, meeting.

Reference and playground for list attendance

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.
meetingA meeting id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/attendance
FieldTypeWhat it holds
idstring
meeting_idstring
jurisdiction_idstring
meeting_datestringYYYY-MM-DD.
member_namestring
officestring or null
attendancestring
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Recordings

GET /v1/recordings

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

Reference and playground for list recordings

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.
meetingA meeting id.

Pages with limit and cursor (pagination).

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

Transcripts

A transcript page is billed on the transcripts meter, not the records meter. See Billing.

GET /v1/meetings/{id}/transcript

A meeting's transcript. 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.

Reference and playground for a meeting's transcript

Path: {id} such as 123456.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/meetings/{id}/transcript
FieldTypeWhat it holds
idstring
recording_idstring
start_msnumber
end_msnumber or null
textstring
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

On this page