Forms

Get a single submission by token

Gets a single submission based on its token and its respective formId

get/api/forms/{formId}/submissions/by-token/{submissionToken}

Path parameters

formIdinteger required

The ID of the form.

submissionTokenstring required

The token of the form submission.

Response

The Submission was retrieved successfully

idstring

isCompleteboolean

jsonDatastring

formIdstring

formDefinitionIdstring

currentPageinteger nullable

metadatastring nullable

tokenstring nullable

completedAtstring date-time nullable

createdAtstring date-time

modifiedAtstring date-time nullable

statusstring

submittedBystring nullable

Changes

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

Nov 21, 202550eff5014b78136See the full diff
- ▲
  media type application/problem+json was changed to a more general media type application/json for the response status 400
  response-media-type-name-generalized
- ●
  removed the optional property errors from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property message from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property statusCode from the response with the 400 status
  response-optional-property-removed
- ○
  added the optional property detail to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property instance to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property submittedBy to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property title to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property type to the response with the 400 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
Mar 24, 2025fbc3fe6ecbf164See the full diff
- ●
  removed the optional property detail from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property instance from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property submittedBy from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 400 status
  response-optional-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  added the optional property errors to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property statusCode to the response with the 400 status
  response-optional-property-added
This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history