API reference · v1

List documents

Current document metadata and council links, without downloading or interpreting PDFs. Pagination stays on the first page’s snapshot.

GET/v1/applications/{id}/documents

Send a secret API key in Authorization: Bearer YOUR_API_KEY. Each successful request uses one of your 500 monthly requests.

Parameters

idpath · required

Opaque ID returned by the corresponding list endpoint. URL-encode the whole value.

limitquery · optional

Page size. 1–100, default 50.

Default: 50

Range: 1–100

cursorquery · optional

Opaque cursor from this endpoint with the same filters. Keep it unchanged; page size may change.

Response fields

itemsarray

Array of the items described below.

Show item fields

idstring

Stable document identifier.

titlestring

Council document title.

sourceTypestring

Original document type.

category"Plans" | "Reports" | "Decisions" | "Forms" | "Correspondence" | "Other"

Broad document grouping inferred from the source title and type; Other is unclassified.

publishedDatestring · optional

Published calendar date Omitted when not collected.

mimeTypestring · optional

Published MIME type Omitted when not collected.

urlstring

Absolute source URL. Council links may change or require a browser session.

listUrlstring

Council document-list page to try if the direct link requires a session.

firstSeenAtstring

UTC time this document was first observed, not its publication date.

lastSeenAtstring

UTC time this document was last present in a collected list.

removedAtstring · optional

When removal was observed; omitted for current documents.

nextCursorstring | null

Continue with this cursor; null when this page exhausts the current query.

snapshotIdstring

Value from the collected source record.

availability"complete" | "partial" | "unavailable" | "not_published"

complete: section collected; partial: some evidence missing; unavailable: could not read; not_published: source explicitly publishes none.

Errors

Error codes, request IDs, retry behaviour, and allowance headers apply to every endpoint. Invalid or repeated query parameters return 400; unavailable records return 404. Source failures never become successful empty results.