---
title: "Return form responses by form"
method: GET
path: "/v1/org/{orgId}/form-response"
tags: ["form-response"]
---

# Return form responses by form

`GET /v1/org/{orgId}/form-response`

## Path parameters

- `orgId` string, required

## Query parameters

- `formId` string
- `assessmentId` string
- `submitPersonId` string
- `targetId` string
- `submitPersonFilter` string
- `targetFilter` string
- `fromId` string
- `fromSubmitAt` string
- `untilSubmitAt` string
- `limit` integer
- `desc` boolean
- `returnAccess` string
- `returnFormVersions` boolean
- `format` string

## Response `200`

successful operation

- ResultsWithFormVersions
  - `data` FormResponse[], required
    - `id` string, required — globally unique id
    - `orgId` string — parent organization id
    - `externalId` string — if the response was imported from an external system, the unique identifier of the response from that system
    - `formId` string — form id that the response is a response for
    - `formVersionId` string — form version id that the response is a response for
    - `submitPersonId` string — person id who filled out the form response (null if anonymous)
    - `submitUserId` string — user id who filled out the form response (can be null if anonymous or imported data)
    - `submitAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `changeId` string — change id, if the form response is linked to a DATA change
    - `assessmentId` string — assessment id, if the form response is related to an assesment
    - `createProcessId` string — process id, if the form response was created from an import process
    - `updateProcessId` string — process id, if the form response was updated from an import process
    - `shareAccess` ShareAccess[] — list of share access, if the form response has been shared with anyone
      - `access` 'NONE' | 'LIMITED_READ' | 'LIMITED_WRITE' | 'STANDARD_READ' | 'STANDARD_WRITE' | 'COMPENSATION_READ' | 'FULL_READ' | 'COMP_PLANNING_PARTICIPANT' | 'COMPENSATION_WRITE' | 'WRITE' | 'COMPENSATION_OWNER' | 'OWNER', required — access permission level
      - `userId` string — user id
      - `groupId` string — group id
      - `fields` string — fields
    - `authorSensitive` 'ANONYMOUS' | 'PRIVATE' | 'HIGH' | 'MANAGER' — sensitivity level of the author of the form response, if it differs from the form response
    - `authorData` object — demographic field data connected with the author of the form response
    - `targetEntityId` string — 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
    - `answers` FormResponseAnswer[] — list of answers in the form response
      - `id` string, required
      - `questionId` string, required
      - `value` object
      - `type` 'ADDRESS' | 'AUDIO' | 'BOOLEAN' | 'COMP' | 'COMPOUND' | 'COMP_BAND' | 'CONTACTS' | 'CURRENCY' | 'DATE' | 'DECIMAL' | 'ELAPSED_DAYS' | 'ELAPSED_MONTHS' | 'ELAPSED_YEARS' | 'EMAIL' | 'ENUM' | 'ENUM_EXPR' | 'ENUM_MULTI' | 'ENUM_SCALE' | 'EXPR' | 'FILE' | 'GROUP' | 'GROUPS' | 'GROUP_ASSIGNMENTS' | 'GROUP_TYPE' | 'GROUP_POSITION_ASSIGNMENTS' | 'IMAGE' | 'INTEGER' | 'JOB' | 'JOB_CODE' | 'JOBS' | 'JOB_TIER' | 'LIST' | 'MAP' | 'MONEY' | 'NAME' | 'OBJECT' | 'PAY_INTERVAL' | 'PERCENT' | 'PERSON' | 'PERSONS' | 'PHONE' | 'STOCKGRANT' | 'STRING' | 'TABLE_REF' | 'TEXT' | 'TIMEOFF' | 'TIMESTAMP' | 'TRACKED_GROUP' | 'URL' | 'USER' | 'VARIABLE_COMP' | 'VARIABLE_COMPS'
      - `plural` 'SINGLE' | 'LIST' | 'SET'
    - `submitAt` string — timestamp that the form response was submitted
    - `approvalAt` string — timestamp that the form response was approved
    - `approvalId` string — user id who approved the form response
    - `approvalNote` string — note left by the user who approved -- this is for backwards compatibility with the old approval system
    - `releaseAt` string — timestamp that the form response was released
    - `releaseId` string — user id who released the form response
    - `fileId` string — if the form response was exported into a file for signature, the id of that file
    - `signAt` string — timestamp that the form response's associated file was fully signed
    - `signerUserIds` string[] — user ids who signed the form response, if it was signed
    - `status` 'ACTIVE' | 'PROPOSED' | 'REJECTED' | 'AWAITING_CHANGES' | 'UNRELEASED' — status of form response
    - `commentCount` integer — number of comments
    - `createId` string — created by user id
    - `createBehalfId` string — created on behalf of user id
    - `createAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `createAt` string — created timestamp
    - `updateId` string — last updated by user id
    - `updateBehalfId` string — last updated on behalf of user id
    - `updateAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `updateAt` string — last updated timestamp
    - `deleteId` string — deleted by user id
    - `deleteBehalfId` string — deleted on behalf of user id
    - `deleteAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `deleteAt` string — deleted timestamp
  - `next` string
  - `access` ResultsAccess[]
    - `ids` string[]
    - `allowed` AccessAction[], required
      - `action` string, required
      - `fields` string[]
      - `types` string[]
  - `formVersions` FormVersionInfo[]
    - `id` string, required
    - `label` string, required
    - `displayName` string, required
    - `displayNameTr` Translations
      - `values` object, required
    - `questions` FormQuestionInfo[], required
      - `id` string, required
      - `question` string, required
      - `questionTr` Translations
        - `values` object, required

## Other responses

- `400` — bad request
- `401` — not authorized
- `404` — not found

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/revisions/2de21f45f447/schema)