Submissions management API
Read authorized submissions from a server using a scoped management token.
Use a separate private credential
The public form key cannot read messages. Create a scoped management token, store only its hash server-side where applicable, and send it only from a trusted environment.
API boundaries
Use /api/v1 workspaces, projects, forms, submissions, exports, and related resources according to the token's explicit scopes. Treat every response as tenant-scoped private data.
| Path | Use |
|---|---|
| GET /api/v1/workspaces/:id/submissions | List within the authorized scope |
| /api/v1/submissions/:id | Manage a submission according to method and permissions |
| /api/v1/workspaces/:id/exports | Create and inspect authorized exports |
Grant only needed scopes
Separate forms:read, forms:write, submissions:read, submissions:delete, rules:write, and exports:create instead of issuing one broad token.
Paginate and minimize personal data
Use bounded pages and filters, avoid copying full submissions into logs, and protect downstream caches and exports with the same care as the source inbox.
Documentation reviewed on October 20, 2026Suggest an improvement →