Skip to main content
Version: v0.16

Forms API Reference

API reference for the Forms module.

Form Submission​

Submit Form​

POST /forms/submit/{formId}

Request Body:

{
  "field1": "value1",
  "field2": "value2"
}

Response:

{
  "message": "Form submitted successfully",
  "submissionId": "..."
}

Admin API​

List Forms​

GET /admin/forms
masterkey: {masterKey}

Get Form​

GET /admin/forms/{formId}
masterkey: {masterKey}

Create Form​

POST /admin/forms
masterkey: {masterKey}

Request Body:

{
  "name": "contact",
  "fields": [
    {"name": "email", "type": "email", "required": true},
    {"name": "message", "type": "textarea", "required": true}
  ],
  "enabled": true
}

Update Form​

PUT /admin/forms/{formId}
masterkey: {masterKey}

Delete Form​

DELETE /admin/forms/{formId}
masterkey: {masterKey}

Submissions​

List Submissions​

GET /admin/forms/{formId}/submissions
masterkey: {masterKey}

Get Submission​

GET /admin/forms/submissions/{submissionId}
masterkey: {masterKey}

Delete Submission​

DELETE /admin/forms/submissions/{submissionId}
masterkey: {masterKey}