Skip to Content
Hey Town Hall Data docs

Records

People

Elected officials, their council appointments, departments and job postings.

View as Markdown

The people a government's own pages name in office, and its public offices. Staff are never listed by name: a department's contact is an office's line, never a person's.

Elected officials

GET /v1/officials

List elected officials. Mayors, councillors, chairs and directors as the government's own page names them. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list elected officials

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe office: mayor, councillor, chair, director.
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/officials
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
officestring
namestring
titlestring or null
takes_officestring or nullSet for someone elected and not yet sworn in.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Council appointments

GET /v1/council-appointments

List council appointments. The boards and committees each elected official sits on, from the newest annual report. Billed as one records request a page. Filters: jurisdiction.

Reference and playground for list council appointments

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/council-appointments
FieldTypeWhat it holds
idstring
jurisdiction_idstring
fiscal_yearnumber or null
member_namestring or null
appointed_tostring or null
rolestring or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Departments

GET /v1/departments

List departments. Departments and their published public contacts (an office's line, never a person's). Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list departments

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe department's role, such as planning.
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/departments
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
departmentstring or null
rolestring or null
phonestring or null
emailstring or null
hoursstring or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Job postings

GET /v1/jobs

List job postings. Open job postings with pay, hours and terms as the posting prints them. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list job postings

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe employment type, such as full_time.
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/jobs
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
titlestring
summarystring or null
locationstring or null
published_atstring or nullISO 8601 instant, UTC.
closes_atstring or nullISO 8601 instant, UTC.
statusstring or null
employment_typestring or null
union_statusstring or null
work_kindstring or null
paystring or nullAs printed.
hoursstring or null
work_locationstring or null
page_readboolean
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

GET /v1/jobs/{id}

Retrieve a job. One job posting with its headed sections. Billed as one records request.

Reference and playground for retrieve a job

Path: {id} such as 123456.

Fields it adds to the list record, GET /v1/jobs/{id}
FieldTypeWhat it holds
sectionsarray of object

On this page