---
title: "Get Module Submission Revision"
method: GET
path: "/modules/{moduleId}/submissions/{submissionId}/revisions/{revisionId}"
tags: ["Revisions"]
---

# Get Module Submission Revision

`GET /modules/{moduleId}/submissions/{submissionId}/revisions/{revisionId}`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/modules/{moduleId}/submissions/{submissionId}/revisions/{revisionId}`
- 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/:submissionId/revisions/:revisionId/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets a single revision for a submission. Revision data is transformed and returned in a specific format, based on the specified transform. JSON revisions 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
- `submissionId` string, required
- `revisionId` string, required

## Query parameters

- `transformName` string
- `includeRaw` boolean
- `includeBase64` boolean
- `resolveCloudStorageUrls` boolean
- `dataFields` string

## Response `200`

Revision

- RetrievedRevisionResponse
  - `id` string, required: Revision id
  - `created` string: Date of when the submission was created or modified (might be missing in old submissions)
  - `createdBy` string: Creator or modifier of the submission (might be missing in old submissions)
  - `persistedInWormStorage` boolean: whether the revision is WORM (Write-Once-Read-Many) compliant. [Click here](https://www.17a-4.com/regulations-summary/) for more information
  - `submission` object, required: Submission object
    - `id` string
    - `userId` string: Submission owner
    - `formId` string
    - `created` string, date-time
    - `modified` string, date-time
    - `deleted` string, date-time
    - `metadata` object
    - `formArchive` string: The form version the revision was saved under
    - `data` object: Transformed output data. Empty for calls that return multiple revisions
      - `format` 'json' | 'xml' | 'pdf'
      - `jsonData` object
      - `xmlData` string
      - `pdfUrl` string, url
      - `pdfData` string
      - `rawData` 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)