ViewRoyal.ai API Docs
API ReferenceSearch

Search across all content types

Full-text keyword search across motions, matters, agenda items, key statements, and document sections. Returns results ranked by relevance with type, score, and text snippets.

GET
/api/v1/{municipality}/search

Authorization

ApiKeyAuth
X-API-Key<token>

API key for authentication. Get your key at /settings/api-keys.

In: header

Path Parameters

municipality*string

Municipality slug (e.g., "view-royal")

Default"view-royal"

Query Parameters

q*string

Search query text

Length1 <= length
type?string

Comma-separated content type filter. Valid: motions, matters, agenda_items, key_statements, document_sections

per_page?integer

Number of results per page (max 100)

Default20
Range1 <= value <= 100
page?integer

Page number (1-based)

Default1
Range1 <= value

Response Body

curl -X GET "https://viewroyal.ai/api/v1/view-royal/search?q=string"
Empty

Get bylaw detail GET

Returns a single bylaw by slug, including its description, summary, and linked matters.

Data Model

Entity relationships in the ViewRoyal.ai API — how meetings, agenda items, motions, matters, bylaws, people, and organizations connect.