Analytics

List submissions

Returns a form's submissions.

get/forms/{formId}/submissions

Request

  • Base URL: https://api.clipform.io/v1
  • URL: https://api.clipform.io/v1/forms/{formId}/submissions
  • Auth: HTTP bearer

Path parameters

formIdstring uuid required

Query parameters

submission_idstring uuid

Filter to the response_set with this id (may still return more than one row if it has multiple completed sessions).

Response

List of submissions

submission_idstring uuid

Stable per-row key: one row per completed session (id = that session's id), or one row for a still-open response_set with no completed session yet (id = the response_set's id).

response_set_idstring uuid

The parent response_set - may repeat across sibling completions of the same set.

session_idstring uuid nullable
statusstring
processing_statusstring nullable

Back-office processing lifecycle: none/complete (ready), pending/processing (in-flight - answers not yet final), processing_error/failed (released unverified).

created_atstring date-time
completed_atstring date-time nullable
last_activity_atstring date-time

When the respondent last made progress (falls back to created_at)

total_sessionsinteger
total_responsesinteger
contact_emailstring nullable
contact_first_namestring nullable
contact_last_namestring nullable
node_responsesobject nullable
lockedboolean

True when this response is over the workspace's plan limit. Locked rows have their answer/contact fields nulled.

Changes

No recorded changes to this operation across all 1 revision of this API.