Results

A simplified view of form submissions with flattened key-value fields. This is the same data as the Submissions API, but returned in a flat format that is easier to work with for integrations, exports, and simple scripts. This API also supports deleting submissions.

List All Results#

Returns all submissions for a form in a flattened format. Each result is a flat object with field IDs as keys and their values as strings. Metadata fields are prefixed with an underscore.

Endpoint:

GET /rest/freshforms/1.0/page/{pageId}/form/{formId}/result

Example:

curl -u username:password \
  https://confluence.example.com/rest/freshforms/1.0/page/123/form/feedbackform/result

Response:

[
  {
    "_timestamp": "1714831200000",
    "_username": "jdoe",
    "_id": "1",
    "comment": "Great page!",
    "rating": "5"
  },
  {
    "_timestamp": "1714831260000",
    "_username": "asmith",
    "_id": "2",
    "comment": "Needs more details",
    "rating": "2"
  }
]

Get a Specific Result#

Returns a single result by its ID.

Endpoint:

GET /rest/freshforms/1.0/page/{pageId}/form/{formId}/result/{id}

Example:

curl -u username:password \
  https://confluence.example.com/rest/freshforms/1.0/page/123/form/feedbackform/result/1

Response:

{
  "_timestamp": "1714831200000",
  "_username": "jdoe",
  "_id": "1",
  "comment": "Great page!",
  "rating": "5"
}

Returns 404 if the submission does not exist.

Update a Result#

Updates an existing submission using the flat field format. Only the fields you include will be updated — existing fields are preserved via a merge. Keys prefixed with _ and the id key are ignored.

Endpoint:

PUT /rest/freshforms/1.0/page/{pageId}/form/{formId}/result/{id}

Example:

curl -u username:password \
  -X PUT \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Updated comment here"
  }' \
  https://confluence.example.com/rest/freshforms/1.0/page/123/form/feedbackform/result/1

Response: Returns 200 OK with the updated result in flat format.

Returns 404 if the submission does not exist. Returns 400 if validation fails.

For multi-value fields (e.g., checkboxes), pass an array of strings. Values will be joined with ; for storage:

curl -u username:password \
  -X PUT \
  -H "Content-Type: application/json" \
  -d '{
    "selectedtools": ["Laptop", "Monitor", "Headset"]
  }' \
  https://confluence.example.com/rest/freshforms/1.0/page/123/form/feedbackform/result/1

Delete a Result#

Permanently deletes a submission.

Endpoint:

DELETE /rest/freshforms/1.0/page/{pageId}/form/{formId}/result/{id}

Example:

curl -u username:password \
  -X DELETE \
  https://confluence.example.com/rest/freshforms/1.0/page/123/form/feedbackform/result/1

Response: Returns 204 No Content on success.

Result Object Reference#

Results are flat objects where each form field ID is a top-level key. Metadata fields use an underscore prefix: