docusign.envelopes.get-page-images

Returns images of the pages in a document for display based on the parameters that you specify.

Returns document page images based on input.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
documentid	string	Yes	—	The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
count	string	No	—	The maximum number of results to return.
dpi	string	No	—	The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height	string	No	—	Sets the maximum height of the returned images in pixels.
max_width	string	No	—	Sets the maximum width of the returned images in pixels.
nocache	string	No	—	When true, using cache is disabled and image information is retrieved from a database. True is the default value.
show_changes	string	No	—	When true, changes display in the user interface.
start_position	string	No	—	The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
documentid	string	Yes	—	The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
count	string	No	—	The maximum number of results to return.
dpi	string	No	—	The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height	string	No	—	Sets the maximum height of the returned images in pixels.
max_width	string	No	—	Sets the maximum width of the returned images in pixels.
nocache	string	No	—	When true, using cache is disabled and image information is retrieved from a database. True is the default value.
show_changes	string	No	—	When true, changes display in the user interface.
start_position	string	No	—	The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.envelopes.get-page-images",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "documentid": "value",
    "envelopeid": "value"
  }
}