Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Submission Versions

Listing Versions

This will return all submission metadata for every version of this submission, in descending creation order.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to return a submitter data object alongside the submitterId Actor ID reference.

get/v1/projects/{projectId}/forms/{xmlFormId}/submissions/{instanceId}/versions

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

instanceIdstring required

The instanceId of the initially submitted version. Please see the notes at the top of this documentation section for more information.

Response

OK

instanceIdstring required

The instanceId of the Submission version, given by the Submission XML.

instanceNamestring

The instanceName, if any, given by the Submission XML in the metadata section.

submitterIdnumber required

The ID of the Actor (App User, User, or Public Link) that submitted this Submission version.

deviceIdstring

The self-identified deviceId of the device that submitted the Submission version.

userAgentstring

The self-identified userAgent of the device that submitted the Submission version.

createdAtstring required

ISO date format. The time that the server received the Submission version.

currentboolean required

Whether the version is current or not.

Example response

[
  {
    "instanceId": "uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44",
    "instanceName": "village third house",
    "submitterId": 23,
    "deviceId": "imei:123456",
    "userAgent": "Enketo/3.0.4",
    "createdAt": "2018-01-19T23:58:03.395Z",
    "current": true
  }
]