DocuSign: Returns document page images based on input — esignature esignature Pages Get Template Page Images
DocuSign esignature.esignaturePagesGetTemplatePageImages: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_pages_gettemplatepageimages
Provider route: GET /restapi/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["esignaturePagesGetTemplatePageImages"]>[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.esignaturePagesGetTemplatePageImages(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_template_page_images(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.documentId | string | Required within parent | |
path.templateId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.count | string | Optional | |
query.dpi | string | Optional | |
query.max_height | string | Optional | |
query.max_width | string | Optional | |
query.nocache | string | Optional | |
query.show_changes | string | Optional | |
query.start_position | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List File Pages — response body |
Referenced models: List File Pages — response body
Schemas
Section titled “Schemas”List File Pages — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The 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. |
pages | array | Optional | An array of page objects. |
pages[] | Model | Each item | Expand Creates a workspace file — response body — thumbnail |
previousUri | string | Optional | The 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. |
resultSetSize | string | Optional | The 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`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Description of a page of a document. |
dpi | string | Optional | The number of dots per inch used for the page image. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details If an error occurs, this property describes the error. |
height | string | Optional | The height of the page in pixels. Must be an integer. |
imageBytes | string | Optional | The number of image bytes. |
mimeType | string | Optional | The MIME type. |
pageId | string | Optional | The ID of the page. |
sequence | string | Optional | The sequence of the page in the document, or page number. |
width | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_pages_gettemplatepageimages. Catalog operation: esignature:Pages_GetTemplatePageImages. 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.