---
title: "Get Module Submissions"
method: GET
path: "/modules/{moduleId}/submissions"
tags: ["Submissions"]
---

# Get Module Submissions

`GET /modules/{moduleId}/submissions`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/modules/{moduleId}/submissions`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/modules/:moduleId/submissions/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns module submission objects for a given module. This is a paged endpoint (see Paging). Module submission data is transformed and returned in a specific format, based on the specified transform. JSON submission data is returned as an object, XML data is returned as a string, and PDF data is returned as a [Cloud Storage Delivery URL](#section/Cloud-Storage-Delivery) to the rendered PDF (and optionally base 64 data).
### Authorization Required:
  - See Submission Access ([Submission Access](#submission-access))

## Path parameters

- `moduleId` string, required

## Query parameters

- `transformName` string
- `limit` integer
- `offset` integer
- `sortBy` string
- `sortOrder` 1 | -1
- `includeDeleted` boolean
- `metadataFilter` string
- `includeRaw` boolean
- `includeBase64` boolean
- `resolveCloudStorageUrls` boolean
- `dataFields` string
- `filter` string

## Response `200`

Submissions

- RetrievedSubmissionResponse[]
  - `id` string, required
  - `userId` string: Submission owner
  - `moduleId` string, required
  - `created` string, date-time, required
  - `modified` string, date-time, required
  - `deleted` string, date-time
  - `data` object, required: Transformed output data
    - `format` 'json' | 'xml' | 'pdf'
    - `jsonData` object
    - `xmlData` string
    - `pdfUrl` string, url
    - `pdfData` string
    - `rawData` object
  - `metadata` object
  - `validationErrors` object[]
    - `id` string
    - `path` string
    - `label` string
    - `parent` string
    - `message` string

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)