v51

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

Listing Comments

Comments have only a body comment text and an actor that made the comment.

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

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

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 being referenced.

Response

OK

bodystring required

The text of the comment.

actorIdnumber required

The ID of the Actor that made the comment.

Example response

[
  {
    "body": "this is my comment",
    "actorId": 42
  }
]