Skip to main content

Get Envelope

Gets an envelope in Docusign.

This node is also exposed as an AI Agent tool.

This node has 1 input port and 1 output port.

Common Properties

Every node shares these.

  • Name — the node's display name on the canvas.
  • Color — the node's colour on the canvas.
  • Delay Before (sec) — wait this long before the node runs.
  • Delay After (sec) — wait this long after the node runs.
  • Continue On Error — carry on instead of failing the flow. Defaults to false.
info

When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.

Inputs

PropertyFieldDescription
Client IDinClientIDClient ID from Connect node (optional if credentials provided)
Envelope IDinEnvelopeIDID of the envelope to retrieve

Outputs

PropertyFieldDescription
Email SubjectoutSubjectEmail subject of the envelope
RecipientsoutRecipientsRecipient information (if Include Recipients is enabled)
ResultoutResultFull envelope details from API
StatusoutStatusCurrent status of the envelope (sent، delivered، completed، voided، etc.)

Options

PropertyFieldDescription
CredentialsoptCredentialsDocusign OAuth2 credentials (optional - use instead of Connect node)
Include RecipientsoptIncludeRecipientsInclude recipient information in the response

Requirements

  • A Client ID from this package's Connect node, unless you set credentials directly on this node.
  • Docusign OAuth2 — Docusign OAuth2 credentials for signing documents
    • _redirect_url — Redirect URL (readonly, optional). Add this to your Docusign app's Redirect URIs
    • client_id — Integration Key (Client ID) (text, required). Integration Key from Docusign Developer Console
    • client_secret — Secret Key (Client Secret) (password, required). Secret Key from Docusign Developer Console
    • use_demo — Use Demo Environment (boolean, optional). Use Docusign demo/sandbox environment (uncheck for production)

Store these in a Vault and reference the vault item from the node, rather than typing the secret into the property.

Create Envelope · Create Envelope from Template · Send Envelope · List Envelopes · Download Document · Void Envelope

Elsewhere in the package: Connect · Disconnect · List Templates · Get Template · Toolkit

See also