Form submission operations

3 operations named submission.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.

Updated10/26/2026

Operation	What it does	Permission	Confirmation
submission.list	List the submissions of a form, newest first, optionally only those with a status, a page at a time.	content.edit	none
submission.setStatus	Mark submissions of a form new, read or archived.	content.edit	none
submission.delete	Delete submissions of a form.	content.edit	destructive

submission.list

List the submissions of a form, newest first, optionally only those with a status, a page at a time. Forms are not versioned: a saved definition takes effect at once.

permission: content.editreads onlyclass: read

Example input

{
  "formId": "d4e5f6a7-b8c9-4d0e-9f1a-3b4c5d6e7f8a",
  "status": "new",
  "limit": 20
}

Input

Field	Type	Required	Notes
formId	string (uuid)	yes
status	string	no	One of "new", "read", "archived".
offset	integer	no	At least 0. Default 0.
limit	integer	no	At least 1. At most 200. Default 50.

Output

Field	Type	Required	Notes
formId	string (uuid)	yes
submissions	array of object	yes
submissions[].id	string (uuid)	yes
submissions[].formId	string (uuid)	yes
submissions[].values	record of string \| boolean	yes
submissions[].status	string	yes	One of "new", "read", "archived".
submissions[].consent	object \| null	yes
submissions[].createdAt	string (date-time)	yes
submissions[].readAt	string (date-time) \| null	yes
total	integer	yes	At least 0.

Try it

yarn splash submission.list '{"formId":"d4e5f6a7-b8c9-4d0e-9f1a-3b4c5d6e7f8a","status":"new","limit":20}' --dry-run

submission.setStatus

Mark submissions of a form new, read or archived. Forms are not versioned: a saved definition takes effect at once.

permission: content.editwrites: submissions:{formId}class: transactionundo: yes

Example input

{
  "formId": "d4e5f6a7-b8c9-4d0e-9f1a-3b4c5d6e7f8a",
  "submissionIds": [
    "e5f6a7b8-c9d0-4e1f-8a2b-4c5d6e7f8a9b",
    "f6a7b8c9-d0e1-4f2a-9b3c-5d6e7f8a9b0c"
  ],
  "status": "archived"
}

Input

Field	Type	Required	Notes
formId	string (uuid)	yes
submissionIds	array of string (uuid)	yes	At least 1 item. At most 200 items.
status	string	yes	One of "new", "read", "archived".

Output

Field	Type	Required	Notes
formId	string (uuid)	yes
updated	integer	yes	At least 0.

Try it

yarn splash submission.setStatus '{"formId":"d4e5f6a7-b8c9-4d0e-9f1a-3b4c5d6e7f8a","submissionIds":["e5f6a7b8-c9d0-4e1f-8a2b-4c5d6e7f8a9b","f6a7b8c9-d0e1-4f2a-9b3c-5d6e7f8a9b0c"],"status":"archived"}' --dry-run

submission.delete

Delete submissions of a form. Run it with confirmed: ["destructive"]. Forms are not versioned: a saved definition takes effect at once.

permission: content.editwrites: submissions:{formId}class: transactionconfirm: destructiveundo: yes

Example input

{
  "formId": "d4e5f6a7-b8c9-4d0e-9f1a-3b4c5d6e7f8a",
  "submissionIds": [
    "e5f6a7b8-c9d0-4e1f-8a2b-4c5d6e7f8a9b"
  ]
}

Input

Field	Type	Required	Notes
formId	string (uuid)	yes
submissionIds	array of string (uuid)	yes	At least 1 item. At most 200 items.

Output

Field	Type	Required	Notes
success	true	yes

Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.

Generated from the operation registry and the MCP tool catalogue (source 05cca63da796fdfb).

Something wrong on this page? Write to docs@librettocms.com.