v3

latestSwagger 2.02026-08-067506752.0 MB

form-response

Return form responses by form

get/v1/org/{orgId}/form-response

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

formIdstring

Form id to filter by

assessmentIdstring

Assessment id to filter by

submitPersonIdstring

Person id to filter by (person who submitted the form)

targetIdstring

Target id to filter by

submitPersonFilterstring

Filter to apply on the submitter

targetFilterstring

Filter to apply on the target

fromIdstring

FormResponse id to start paginating from

fromSubmitAtstring

Submit timestamp to start from (inclusive)

untilSubmitAtstring

Submit timestamp to go until (exclusive)

limitinteger

Number of results to return

descboolean

Whether to return results sorted in descending timestamp order

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

returnFormVersionsboolean

Return form versions (question ids / text) alongside the responses

formatstring

Data format to use; default is json, can also use json-extended or json-readable

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "externalId": "google:1234567890",
      "formId": "588f7ee98f138b19220041a7",
      "formVersionId": "588f7ee98f138b19220041a7",
      "submitPersonId": "588f7ee98f138b19220041a7",
      "submitUserId": "588f7ee98f138b19220041a7",
      "submitAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "changeId": "588f7ee98f138b19220041a7",
      "assessmentId": "588f7ee98f138b19220041a7",
      "createProcessId": "588f7ee98f138b19220041a7",
      "updateProcessId": "588f7ee98f138b19220041a7",
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "targetEntityId": "588f7ee98f138b19220041a7",
      "answers": [
        {
          "id": "588f7ee98f138b19220041a7",
          "questionId": "588f7ee98f138b19220041a7"
        }
      ],
      "approvalId": "588f7ee98f138b19220041a7",
      "releaseId": "588f7ee98f138b19220041a7",
      "fileId": "588f7ee98f138b19220041a7",
      "signerUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ],
  "next": "588f7ee98f138b19220041a7",
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ],
  "formVersions": [
    {
      "id": "588f7ee98f138b19220041a7",
      "questions": [
        {
          "id": "588f7ee98f138b19220041a7"
        }
      ]
    }
  ]
}