---
title: "List Form Submission"
method: POST
path: "/form-submission/get-list"
tags: ["Form Submission"]
---

# List Form Submission

`POST /form-submission/get-list`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/form-submission/get-list`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/form-submission/get-list/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to list all Form Submission items

## Request body

- object
  - `query` FormSubmissionQuerySchema: Query schema for FormSubmission. A field takes a value, which it matches exactly, or an operator its type allows. A relation is filtered by the fields of the record it names, {"<relation>": {"<field>": <value or Search>}}, and a resource with owners by who owns it, {"owners": {"_type": "OwnedBy", "userIds": [...], "teamIds": [...]}}.
    - `_id` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `createdAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `updatedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `deletedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `projectId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `formId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `answers` union: A filter on a JSON field, by key: {"<field>": {"<key>": <value or operator>}}. A key takes a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. IsNull and NotNull on the field itself ask whether it holds anything.
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
    - `submitterName` union: A filter on a Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `submitterEmail` union: A filter on a Email field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, email
      - object
        - `_type` 'EqualTo', required
        - `value` string, email, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, email, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, email, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `targetType` union: A filter on a Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `incidentId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `scheduledMaintenanceId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
  - `select` FormSubmissionSelectSchema: Select schema for FormSubmission. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `formId` boolean
    - `answers` boolean
    - `submitterName` boolean
    - `submitterEmail` boolean
    - `targetType` boolean
    - `incidentId` boolean
    - `scheduledMaintenanceId` boolean
  - `sort` FormSubmissionSortSchema: Sort schema for FormSubmission. Only sortable fields are included.
    - `_id` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `createdAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `updatedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `deletedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `projectId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `formId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `submitterName` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `targetType` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `incidentId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `scheduledMaintenanceId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
  - `limit` number: Maximum number of items to return. Defaults to 10.
  - `skip` number: Number of items to skip for pagination. Defaults to 0.

## Response `200`

Successful response

- object
  - `data` FormSubmission[]
    - `_id` string, uuid: ID of this object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `formId` string, uuid, required: ID of the form this submission was made through. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `answers` object: Every question the submitter answered, in the form's order: the question's id (fieldId), its label when the form was submitted, the stored value, and the value as a person reads it (displayValue). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `submitterName` string: The name the submitter gave, as they typed it. Empty when the form does not ask for it, or lets people leave it out and they did. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `submitterEmail` object: The email address the submitter gave. It is not verified, and nothing is sent to it. Empty when the form does not ask for it, or lets people leave it out and they did. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `targetType` 'Incident' | 'ScheduledMaintenance': What the submission created: Incident, or ScheduledMaintenance (a scheduled maintenance event). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `incidentId` string, uuid: ID of the incident this submission created. Empty for a form that schedules maintenance, and once that incident is deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
    - `scheduledMaintenanceId` string, uuid: ID of the scheduled maintenance event this submission created. Empty for a form that creates incidents, and once that event is deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Read Form Submission], Update: [No access - you don't have permission for this operation]
  - `count` number

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)