> ## Documentation Index
> Fetch the complete documentation index at: https://developers.formstack.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /form/{formId}/partialsubmission

Get a list of partial submissions for a form

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Formstack API v2025.0",
    "version": "0.0.4"
  },
  "servers": [
    {
      "url": "https://www.formstack.com/api/v2025",
      "description": "Production server"
    },
    {
      "url": "https://staging-formstack.com/api/v2025",
      "description": "Staging server"
    },
    {
      "url": "https://dev-formstack.com/api/v2025",
      "description": "Development server"
    }
  ],
  "paths": {
    "/form/{formId}/partialsubmission": {
      "get": {
        "tags": [
          "PartialSubmissions",
          "Classic"
        ],
        "description": "Get a list of partial submissions for a form",
        "operationId": "getPartialSubmissionsList",
        "parameters": [
          {
            "name": "formId",
            "in": "path",
            "description": "The ID of the form",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Page to use when paginating through partial submissions.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/pageNumber"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of partial submissions to return per page.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/pageSize"
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "Order direction of results.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/order"
            }
          },
          {
            "name": "keyword",
            "in": "query",
            "description": "Keyword to search.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/keyword"
            }
          },
          {
            "name": "minTime",
            "in": "query",
            "description": "Return partial submissions created at and after the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/minTime"
            }
          },
          {
            "name": "maxTime",
            "in": "query",
            "description": "Return partial submissions created at and before the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/maxTime"
            }
          },
          {
            "name": "search",
            "in": "query",
            "description": "Field ids and related values to search (according to the following pattern where search index has to be smaller than 10: search[0][fieldId]=111&search[0][value]=foo&search[1][fieldId]=112&search[1][value]=bar).",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/search"
            }
          },
          {
            "name": "data",
            "in": "query",
            "description": "Set to 'true' to include partial submission data in the response.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/data"
            }
          },
          {
            "name": "expandData",
            "in": "query",
            "description": "Set to 'true' to expand partial submission data with detailed field information.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/expandData"
            }
          },
          {
            "name": "prettyName",
            "in": "query",
            "description": "Set to 'true' to include pretty names for partial submissions.",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetPartialSubmissionsListApiDto/properties/prettyName"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PartialSubmissionsListingApiDto"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PartialSubmissionPreviewApiDto": {
        "title": "Partial Submission Preview",
        "description": "Partial submission preview response",
        "properties": {
          "id": {
            "description": "The ID of the partial submission",
            "type": "integer",
            "nullable": false
          },
          "formId": {
            "description": "The ID of the partial submission form",
            "type": "integer",
            "nullable": false
          },
          "timestamp": {
            "description": "Timestamp of the partial submission",
            "type": "string",
            "nullable": false
          },
          "data": {
            "description": "Data of the partial submission (equals null also if this field isn't requested)",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PartialSubmissionPreviewDataApiDto"
            },
            "nullable": true
          },
          "prettyName": {
            "description": "Pretty name of the partial submission (equals null also if this field isn't requested)",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object"
      },
      "PartialSubmissionPreviewDataApiDto": {
        "title": "Partial Submission Preview Data",
        "description": "Partial submission preview data response"
      },
      "PartialSubmissionsListingApiDto": {
        "title": "Partial Submissions Listing",
        "description": "Partial submissions listing response",
        "properties": {
          "page": {
            "$ref": "#/components/schemas/PaginationApiDto"
          },
          "partialSubmissions": {
            "description": "Preview of partial submission in list",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PartialSubmissionPreviewApiDto"
            },
            "nullable": true
          }
        },
        "type": "object"
      },
      "GetPartialSubmissionsListApiDto": {
        "title": "Get Partial Submissions List",
        "description": "Get partial submissions list params",
        "properties": {
          "pageNumber": {
            "description": "Page to use when paginating through items.",
            "type": "integer",
            "minimum": 1,
            "nullable": true
          },
          "pageSize": {
            "description": "Number of items to return per page.",
            "type": "integer",
            "default": 50,
            "maximum": 500,
            "minimum": 10,
            "nullable": true
          },
          "order": {
            "description": "Order direction of results.",
            "type": "string",
            "default": "ASC",
            "enum": [
              "ASC",
              "DESC"
            ],
            "nullable": true
          },
          "keyword": {
            "description": "Keyword to search.",
            "type": "string",
            "nullable": true
          },
          "minTime": {
            "description": "Return partial submissions created at and after the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).",
            "type": "string",
            "nullable": true
          },
          "maxTime": {
            "description": "Return partial submissions created at and before the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).",
            "type": "string",
            "nullable": true
          },
          "search": {
            "description": "Array of search criteria to filter partial submissions by specific field values. Each criterion must include a fieldId and value. Maximum 10 search criteria allowed (index 0-9).",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchCriterionDto"
            },
            "example": [
              {
                "fieldId": "123456",
                "value": "john@example.com"
              },
              {
                "fieldId": "789012",
                "value": "New York"
              }
            ],
            "nullable": true
          },
          "data": {
            "description": "Set to 'true' to include partial submission data in the response.",
            "type": "string",
            "nullable": true
          },
          "expandData": {
            "description": "Set to 'true' to expand partial submission data with detailed field information.",
            "type": "string",
            "nullable": true
          },
          "prettyName": {
            "description": "Set to 'true' to include pretty names for partial submissions.",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object"
      },
      "PaginationApiDto": {
        "title": "Pagination Info",
        "description": "Pagination information",
        "properties": {
          "size": {
            "description": "The amount of records returned for this page",
            "type": "integer",
            "nullable": false
          },
          "pageNumber": {
            "description": "The current page number",
            "type": "integer",
            "nullable": false
          },
          "pageSize": {
            "description": "The actual page size",
            "type": "integer",
            "nullable": false
          },
          "totalElements": {
            "description": "The total amount of resources available",
            "type": "integer",
            "nullable": false
          },
          "totalPages": {
            "description": "The total amount of pages available, based on the pageSize",
            "type": "integer",
            "nullable": false
          }
        },
        "type": "object"
      },
      "SearchCriterionDto": {
        "title": "Search Criterion",
        "description": "A single search criterion for filtering by field value",
        "properties": {
          "fieldId": {
            "description": "The ID of the field to search",
            "type": "string",
            "example": "123456"
          },
          "value": {
            "description": "The value to search for in the field",
            "type": "string",
            "example": "john@example.com"
          }
        },
        "type": "object"
      }
    }
  },
  "tags": [
    {
      "name": "PartialSubmissions",
      "description": "Partial submissions capture form data that a respondent entered but did not finish submitting (Save & Resume / abandoned entries). Use these endpoints to list and search a form's partial submissions, retrieve the details of one, and delete partial submissions."
    },
    {
      "name": "Classic",
      "description": "Classic"
    }
  ]
}
```