> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# DocumentPreview Resource

DocumentPreview resource

> **Warning**
>
> Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact [Docusign Sales](https://www.docusign.com/contact-sales).

## Methods supported

| Method                                                                                                                 | Description                                                                                                  |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [GetDocumentPreview](/docs/clm-api/reference/objects/documentpreview/getdocumentpreview)                               | GET `/v2/{accountId}/documentPreviews/{id}` Gets the document preview.                                       |
| [GetDocumentPreviewPageImageStatus](/docs/clm-api/reference/objects/documentpreview/getdocumentpreviewpageimagestatus) | GET `/v2/{accountId}/documentPreviews/{id}/pageImageStatuses` Gets the document preview page image statuses. |
| [GetDocumentPreviewPages](/docs/clm-api/reference/objects/documentpreview/getdocumentpreviewpages)                     | GET `/v2/{accountId}/documentPreviews/{id}/pages` Gets the document preview pages.                           |

## DocumentPreview properties

| Property                 | Type     | Description                                                                 |
| ------------------------ | -------- | --------------------------------------------------------------------------- |
| `Document`               | Document | Gets or sets the document.                                                  |
| `Href`                   | string   | Uri where the object can be retrieved.                                      |
| `IsPreviewAvailable`     | boolean  | Gets or sets a value indicating whether this instance is preview available. |
| `PageImagesAvailability` | array    | Gets or sets the page images availability.                                  |
| `Pages`                  | array    | Gets or sets the pages.                                                     |
| `PreviewReason`          | string   | Gets or sets the preview reason.                                            |


## API Docs

- DocumentPreview [Get document preview](https://developers.docusign.com/docs/clm-api/reference/objects/documentpreview/getdocumentpreview.md)
- DocumentPreview [Get document preview page image statuses](https://developers.docusign.com/docs/clm-api/reference/objects/documentpreview/getdocumentpreviewpageimagestatus.md)
- DocumentPreview [Get document preview pages](https://developers.docusign.com/docs/clm-api/reference/objects/documentpreview/getdocumentpreviewpages.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.docusign.com/openapi.json)
- [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)