docusign.envelopes.get-envelope

Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges . ### Related topics - How to get envelope information

Gets the status of a single envelope.

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.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
advanced_update	string	No	—	When true, envelope information can be added or modified.
include	string	No	—	Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are: - custom_fields: The custom fields associated with the envelope. - documents: The documents associated with the envelope. - attachments: The attachments associated with the envelope. - extensions: The email settings associated with the envelope. - folders: The folder where the envelope exists. - recipients: The recipients associated with the envelope. - powerform: The PowerForms associated with the envelope. - prefill_tabs: The pre-filled tabs associated with the envelope. - tabs: The tabs associated with the envelope. - payment_tabs: The payment tabs associated with the envelope. - workflow: The workflow definition associated with the envelope.
include_anchor_tab_locations	string	No	—	When true, all tabs with anchor tab properties are included in the response. The default value is false.
user_id	string	No	—	—

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.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
advanced_update	string	No	—	When true, envelope information can be added or modified.
include	string	No	—	Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are: - custom_fields: The custom fields associated with the envelope. - documents: The documents associated with the envelope. - attachments: The attachments associated with the envelope. - extensions: The email settings associated with the envelope. - folders: The folder where the envelope exists. - recipients: The recipients associated with the envelope. - powerform: The PowerForms associated with the envelope. - prefill_tabs: The pre-filled tabs associated with the envelope. - tabs: The tabs associated with the envelope. - payment_tabs: The payment tabs associated with the envelope. - workflow: The workflow definition associated with the envelope.
include_anchor_tab_locations	string	No	—	When true, all tabs with anchor tab properties are included in the response. The default value is false.
user_id	string	No	—	—
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/
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/
* (any state)	fail	failed	Record the failure reason

API Usage

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

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