Sign in
Forms

Get a list of Submissions for a given form

Returns all submissions for a form given formId. Includes all Form Definitions as well as complete and non-complete responses

get/api/forms/{formId}/submissions

Path parameters

formIdinteger required

The ID of the form.

Query parameters

pageinteger nullable

The number of the page

pageSizeinteger nullable

The number of items to take.

filterstring[] nullable

The filter expressions

Response

List of form Submissions

idinteger

The unique identifier of the submission.

isCompleteboolean

Indicates if the submission is complete.

jsonDataobject

A dictionary containing JSON data related to the submission.

metadatastring nullable

Additional metadata related to the submission.

formIdinteger

The unique identifier of the form associated with the submission.

formDefinitionIdinteger

The unique identifier of the form definition associated with the submission.

currentPageinteger nullable

The current page of the submission, if applicable.

completedAtstring date-time nullable

The date and time when the submission was completed, if applicable.

createdAtstring date-time

The date and time when the submission was created.

statusstring

The status of the submission.

submittedBystring nullable

The unique identifier of the user who created the submission, if applicable.

Changes

Changed in 2 of the 7 revisions of this API.112

  • 50eff5014b7811See the full diff
    • ▲

      removed the media type application/problem+json for the response with the status 400

      response-media-type-removed

    • ○

      added the optional property items/submittedBy to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fbc3fe6ecbf111See the full diff
    • ●

      removed the optional property items/submittedBy from the response with the 200 status

      response-optional-property-removed

    • ○

      added the media type application/problem+json for the response with the status 400

      response-media-type-added

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog