Title here
Summary here
Overview
This guide covers the FreshForms REST API for programmatically interacting with forms and submissions. All endpoints require Confluence authentication (e.g., HTTP Basic Auth).
Base URL
All API paths are relative to your Confluence base URL:
{baseurl}/rest/freshforms/1.0Example:
https://confluence.example.com/rest/freshforms/1.0Authentication
All requests require Confluence authentication. Use HTTP Basic Auth with your Confluence username and password:
curl -u username:password https://confluence.example.com/rest/freshforms/1.0/...API Endpoints
Forms
Read-only access to form definitions on a page.
| Method | Path | Description |
|---|---|---|
| GET | /page/{pageId}/form | List all forms on a page |
| GET | /page/{pageId}/form/{formId} | Get a specific form definition |
Submissions
Create and manage form submissions. Returns the full submission model with nested field objects.
| Method | Path | Description |
|---|---|---|
| GET | /page/{pageId}/form/{formId}/submission | List all submissions |
| GET | /page/{pageId}/form/{formId}/submission/{id} | Get a specific submission |
| POST | /page/{pageId}/form/{formId}/submission | Create a new submission |
| POST | /page/{pageId}/form/{formId}/submission/{id} | Update a submission |
Results
A simplified view of submissions with flattened key-value fields. Useful for integrations that don’t need the full submission structure.
| Method | Path | Description |
|---|---|---|
| GET | /page/{pageId}/form/{formId}/result | List all results (flattened) |
| GET | /page/{pageId}/form/{formId}/result/{id} | Get a specific result |
| PUT | /page/{pageId}/form/{formId}/result/{id} | Update a result |
| DELETE | /page/{pageId}/form/{formId}/result/{id} | Delete a result |
Next
Forms