v3

latestSwagger 2.02026-08-067506752.0 MB

form-response

Return a particular form response by id

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

formResponseIdstring required

FormResponse id

Query parameters

formatstring

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

Response

successful operation

idstring required

globally unique id

orgIdstring

parent organization id

externalIdstring

if the response was imported from an external system, the unique identifier of the response from that system

formIdstring

form id that the response is a response for

formVersionIdstring

form version id that the response is a response for

submitPersonIdstring

person id who filled out the form response (null if anonymous)

submitUserIdstring

user id who filled out the form response (can be null if anonymous or imported data)

changeIdstring

change id, if the form response is linked to a DATA change

assessmentIdstring

assessment id, if the form response is related to an assesment

createProcessIdstring

process id, if the form response was created from an import process

updateProcessIdstring

process id, if the form response was updated from an import process

authorSensitive'ANONYMOUS' | 'PRIVATE' | 'HIGH' | 'MANAGER'

sensitivity level of the author of the form response, if it differs from the form response

authorDataobject

demographic field data connected with the author of the form response

targetEntityIdstring

target entity id -- the entity that the form response is about

targetEntityType'NONE' | 'PERSON'

target entity type -- the entity that the form response is about

submitAtstring

timestamp that the form response was submitted

approvalAtstring

timestamp that the form response was approved

approvalIdstring

user id who approved the form response

approvalNotestring

note left by the user who approved -- this is for backwards compatibility with the old approval system

releaseAtstring

timestamp that the form response was released

releaseIdstring

user id who released the form response

fileIdstring

if the form response was exported into a file for signature, the id of that file

signAtstring

timestamp that the form response's associated file was fully signed

signerUserIdsstring[]

user ids who signed the form response, if it was signed

status'ACTIVE' | 'PROPOSED' | 'REJECTED' | 'AWAITING_CHANGES' | 'UNRELEASED'

status of form response

commentCountinteger

number of comments

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "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"
}