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 | String | TRUE |
Output
Field | Definition | Type |
---|---|---|
Envelope | ||
Status | Envelope status; one of: completed, created, declined, delivered, sent, signed, or voided | String |
Email Subject | Subject of the email | String |
Email Body | Body of the email | String |
Brand ID | ID of the brand | Dropdown |
Allow Markup | Indicates whether markup is allowed | Boolean |
Allow Reassign | Indicates whether the envelope can be reassigned | Boolean |
Allow Comments | Indicates whether comments are allowed | Boolean |
Auto Navigation | Indicates whether auto navigation is enabled | Boolean |
Message Lock | Indicates whether the message is locked | Boolean |
Allow View History | Indicates whether the envelope history can be viewed | Boolean |
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 | String |
User ID | ID of the sender | String |
Account ID | Account ID of the sender | String |
Email address of the sender | String |
Document | ||
Name | Name of the document | String |
Document ID | ID of the document | String |
Authoritative Copy | Indicates whether the document is the authoritative copy | Boolean |
Recipients | ||
Signers | ||
Email address of the editor | String | |
Name | Name of the editor | String |
User ID | User ID of the editor | String |
Recipient ID | ID of the editor | String |
In Person Signers | ||
Host Email | Email address of the host | String |
Host Name | Name of the host | String |
Signer Email | Email address of the signer | String |
Signer Name | Name of the signer | String |
User ID | ID of the user | String |
Recipient ID | ID of the recipient | String |
Intermediaries | ||
Email address of the editor | String | |
Name | Name of the editor | String |
User ID | User ID of the editor | String |
Recipient ID | ID of the editor | String |
Certified Deliveries | ||
Email address of the editor | String | |
Name | Name of the editor | String |
User ID | User ID of the editor | String |
Recipient ID | ID of the editor | String |
Carbon Copies | ||
Email address of the editor | String | |
Name | Name of the editor | String |
User ID | User ID of the editor | String |
Recipient ID | ID of the editor | String |
Editors | ||
Email address of the editor | String | |
Name | Name of the editor | String |
User ID | User ID of the editor | String |
Recipient ID | ID of the editor | String |
Agents | ||
Witness For | Whose signature is being witnessed | String |
Email address of the agent | String | |
Name | Name of the agent | String |
User ID | User ID of the agent | String |
Recipient ID | ID of the agent | String |
Reminders | ||
Reminder Delay | Number of days to wait after creating the envelope before sending first reminder | Number |
Reminder Enabled | Indicates whether reminders are enabled | Boolean |
Reminder Frequency | Frequency (in days) to send additional reminders after the first | Number |
Expiration | ||
Expiration Enabled | Indicates whether expiration is enabled | Boolean |
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 | String |
Name | Name of the template | String |
Applied | Reserved for DocuSign | String |
URI | URI that contains the user ID | String |