Skip to content

DocuSign: Returns document page images based on input — esignature esignature Pages Get Page Images

DocuSign esignature.esignaturePagesGetPageImages: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_pages_getpageimages

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignaturePagesGetPageImages"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignaturePagesGetPageImages(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_pages_get_page_images(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.documentIdstringRequired within parent
path.envelopeIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.countstringOptional
query.dpistringOptional
query.max_heightstringOptional
query.max_widthstringOptional
query.nocachestringOptional
query.show_changesstringOptional
query.start_positionstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List File Pages — response body

Referenced models: List File Pages — response body

List File Pages — response body
FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
pagesarrayOptionalAn array of page objects.
pages[]ModelEach itemExpand Creates a workspace file — response body — thumbnail
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Creates a workspace file — response body — thumbnail

Creates a workspace file — response body — thumbnail
FieldTypePresenceDescription and constraints
$objectRootDescription of a page of a document.
dpistringOptionalThe number of dots per inch used for the page image.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
If an error occurs, this property describes the error.
heightstringOptionalThe height of the page in pixels.
Must be an integer.
imageBytesstringOptionalThe number of image bytes.
mimeTypestringOptionalThe MIME type.
pageIdstringOptionalThe ID of the page.
sequencestringOptionalThe sequence of the page in the document, or page number.
widthstringOptionalThe width of the page in pixels.
Must be an integer.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_pages_getpageimages. Catalog operation: esignature:Pages_GetPageImages. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.