Versioning
/api/public/v1/ is a stable v1 contract. Breaking changes will only ship in /v2/ (a future addition). Non-breaking additions ship to v1 directly.
What counts as breaking
We consider these breaking and won't ship them in v1:
- Removing endpoints
- Removing response fields
- Renaming response fields
- Changing response field types (e.g. number → string)
- Changing required request fields
- Changing the meaning of a field (semantic break)
- Tightening validation rules that previously accepted now-rejected input
What counts as non-breaking (ships to v1)
- Adding new endpoints
- Adding new optional request fields
- Adding new response fields (clients should ignore unknown fields)
- Loosening validation rules (accepting more input)
- Performance improvements
- Bug fixes that bring behavior in line with documented contract
What's NOT in v1
Most of these are intentionally internal-only:
| Resource | Why |
|---|---|
| Documents (templates, generation, instances) | Late-stage feature; integration patterns still evolving |
| Forms management (create/edit) | UI-only — read-only API access via /forms/* |
| Automations management | UI-only — automations are the platform's surface for webhooks + scheduled jobs |
| Scheduled reports | UI-only configuration; results are emailed |
| Member groups | UI-only — groups are used for per-user access grants |
| DataTable views | UI-only — views are presentation-layer state |
| Dashboards | UI-only — too widget-rich for a v1 contract |
| Billing / API key management | Workspace-admin-only, audit-sensitive |
| Bulk UPDATE/DELETE by filter | Use the in-app SQL Console |
| Creating new datatables | UI-only — schema design has implications (formulas, autonumbers, indexes) |
| DELETE on spaces and lists | Cascade-delete tasks; UI-only with confirmation |
| Folder management | UI-only — folders are presentational |
| Privacy toggles | Requires per-user access grants which can't be expressed through API key auth |
Need something on this list?
Reach out at team@konduit.work with your use case. Some items are firmly UI-only by design (anything cascade-deletes, anything billing-related); others are just unprioritized for v1 and can move forward if there's demand.
Migration policy
When a v2 ships, v1 will continue to serve for at least 12 months in parallel. Deprecation will be announced in the changelog and via email to all workspaces with active API keys.
Changelog
Significant API changes are listed at /api/changelog/ (coming soon).