v51

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

Submissions

Retrieving Audit Logs

(introduced: version 1.2)

You can retrieve all Server Audit Logs relating to a submission. They will be returned most recent first.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to additionally expand the actorId into full actor details, and acteeId into full actee details. The actor will always be an Actor, and the actee will be the Form this Submission is a part of.

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

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 Submission.

Response

actorIdnumber

The ID of the actor, if any, that initiated the action.

actionstring required

The action that was taken.

acteeIdstring

The ID of the permissioning object against which the action was taken.

detailsobject

Additional details about the action that vary according to the type of action.

loggedAtstring required

ISO date format

Example response

[
  {
    "actorId": 42,
    "action": "form.create",
    "acteeId": "85cb9aff-005e-4edd-9739-dc9c1a829c44",
    "loggedAt": "2018-04-18T23:19:14.802Z"
  }
]