DocumentationGuides & reference
Search across guides and reference articles. Try “email”, “API” or “conditions”.
Developers
Govform API & MCP
Discover services and schemas, read submitted data and analytics, and manage deployments and connected access.
17 articles
Start here
Service discovery, schemas & design
- List services, metadata and form schemasDiscover Service IDs and metadata, read field schemas and definitions, and distinguish deployment history from live status.↗
- Create, update and delete services through the APICreate services, save full definitions under a lock, delete undeployed services and prepare deployments.↗
Submissions, files & analytics
- Fetch submitted form dataRetrieve submissions in JSON or CSV, with filters and pagination.↗
- Fetch analytics eventsRetrieve page views, completion and other raw analytics events.↗
- Fetch journey analytics recordsRetrieve analytics for individual journeys, including incomplete journeys.↗
- Delete submitted form dataDelete submitted data through the API.↗
- List and download uploaded files and signaturesList and download files and signatures from submissions.↗
- Set submitted form statusUpdate the status of a submitted form.↗
Service deployments & User portal
Collection programmes, MCP & Darcy
- Collection programme APIUse the Collection programme API to coordinate expected, time-bounded Collections, manage respondent assignments and work with submitted responses and reviews.↗
- Govform MCP capabilitiesMCP API units: Each tools/call is charged by the operation it runs. Initialization, tool discovery, resources and prompts do not use monthly units.↗
- Bulk Data files and submitted revisionsA Bulk Data answer is compact metadata, not an array of rows or file contents. The validated CSV includes the respondent's corrections. Their first submitted CSV is…↗
- Discover and run Darcy REST toolsDiscover the permitted Darcy tool catalogue and invoke its advertised REST operations.↗