Read Envelope
Read an envelope in DocuSign.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
|
Accounts |
Choose from available DocuSign accounts. |
Dropdown |
TRUE |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Envelope ID |
Unique ID of the envelope. |
Text |
TRUE |
Output
| Field | Definition | Type |
|---|---|---|
|
Envelope |
||
|
Status |
Envelope status; one of: completed, created, declined, delivered, sent, signed, or voided. |
Text |
|
Email Subject |
Subject of the email. |
Text |
|
Email Body |
Body of the email. |
Text |
|
Brand ID |
ID of the brand. |
Dropdown |
|
Allow Markup |
Indicates whether markup is allowed. |
True/False |
|
Allow Reassign |
Indicates whether the envelope can be reassigned. |
True/False |
|
Allow Comments |
Indicates whether comments are allowed. |
True/False |
|
Auto Navigation |
Indicates whether auto navigation is enabled. |
True/False |
|
Message Lock |
Indicates whether the message is locked. |
True/False |
|
Allow View History |
Indicates whether the envelope history can be viewed. |
True/False |
|
Created Date Time |
Date and time the envelope was created. |
Date & Time |
|
Last Modified Date Time |
Date and time the envelope was last modified. |
Date & Time |
|
Status Changed Date Time |
Date and time the status of the envelope last changed. |
Date & Time |
|
Sender |
||
|
Username |
Username of the sender. |
Text |
|
User ID |
Unique identifier of the user. |
Text |
|
Account ID |
Account ID of the sender. |
Text |
|
|
Email address of the sender. |
Text |
|
Document |
||
|
Name |
Name of the document. |
Text |
|
Document ID |
ID of the document. |
Text |
|
Authoritative Copy |
Indicates whether the document is the authoritative copy. |
True/False |
|
Recipients |
||
|
Signers |
||
|
|
Email address of the editor. |
Text |
|
Name |
Name of the editor. |
Text |
|
User ID |
User ID of the editor. |
Text |
|
Recipient ID |
ID of the editor. |
Text |
|
In Person Signers |
||
|
Host Email |
Email address of the host. |
Text |
|
Host Name |
Name of the host. |
Text |
|
Signer Email |
Email address of the signer. |
Text |
|
Signer Name |
Name of the signer. |
Text |
|
User ID |
ID of the user. |
Text |
|
Recipient ID |
ID of the recipient. |
Text |
|
Intermediaries |
||
|
|
Email address of the editor. |
Text |
|
Name |
Name of the editor. |
Text |
|
User ID |
User ID of the editor. |
Text |
|
Recipient ID |
ID of the editor. |
Text |
|
Certified Deliveries |
||
|
|
Email address of the editor. |
Text |
|
Name |
Name of the editor. |
Text |
|
User ID |
User ID of the editor. |
Text |
|
Recipient ID |
ID of the editor. |
Text |
|
Carbon Copies |
||
|
|
Email address of the editor. |
Text |
|
Name |
Name of the editor. |
Text |
|
User ID |
User ID of the editor. |
Text |
|
Recipient ID |
ID of the editor. |
Text |
|
Editors |
||
|
|
Email address of the editor. |
Text |
|
Name |
Name of the editor. |
Text |
|
User ID |
User ID of the editor. |
Text |
|
Recipient ID |
ID of the editor. |
Text |
|
Agents |
||
|
Witness For |
Whose signature is being witnessed. |
Text |
|
|
Email address of the agent. |
Text |
|
Name |
Name of the agent. |
Text |
|
User ID |
User ID of the agent. |
Text |
|
Recipient ID |
ID of the agent. |
Text |
|
Reminders |
||
|
Reminder Delay |
Number of days to wait after creating the envelope before sending first reminder. |
Number |
|
Reminder Enabled |
Indicates whether reminders are enabled. |
True/False |
|
Reminder Frequency |
Frequency (in days) to send additional reminders after the first. |
Number |
|
Expiration |
||
|
Expiration Enabled |
Indicates whether expiration is enabled. |
True/False |
|
Expire After |
Number of days after which the envelope expires. |
Number |
|
Expire Warning |
Number of days before envelope expires to send an expiration warning. |
Number |
|
Template |
||
|
Template ID |
Unique ID of the envelope. |
Text |
|
Name |
Name of the template. |
Text |
|
Applied |
Reserved for DocuSign. |
Text |
|
URI |
URI that contains the user ID. |
Text |