Skip to navigation
API referenceObjectsDocumentPreview

Get document preview

View as Markdown

Gets the document preview.

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.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.

Path parameters

idstringRequiredformat: "uuid"
The identifier.
accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Query parameters

extractPagesbooleanOptional

if set to true [extract pages].

extractOverlaysbooleanOptional

if set to true [extract overlays].

processOverlaysbooleanOptional

if set to true [process overlays].

Response

OK
PreviewReasonenumOptional
Gets or sets the preview reason.
IsPreviewAvailablebooleanOptional
Gets or sets a value indicating whether this instance is preview available.
PageImagesAvailabilitylist of booleansOptional
Gets or sets the page images availability.
Pageslist of objectsOptional
Gets or sets the pages.
HrefstringOptional
Uri where the object can be retrieved.
DocumentobjectOptional
Gets or sets the document.