FlowmageDocs
DocuSign

Get envelope

BetaReads data

Reads a DocuSign envelope's status and its recipients' progress.

Settings

SettingWhat it is
ConnectionRequiredThe DocuSign connection the step signs in with.
Envelope idRequiredtext
IncludeComma-separated: recipients, documents, tabs. DocuSign allows ONE status check per envelope per 15 minutes — put this behind a schedule of 20 minutes or more, or use a DocuSign Connect webhook instead.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `docusign`)
envelopeIdtext
includetext, by default "recipients"

Output

FieldType
envelopeIdstring
statusstring
statusChangedDateTimeStatus changed atstring
sentDateTimeSent atstring
completedDateTimeCompleted atstring
recipientsobject
envelopeobject
Sample output, and the expression for each field
  • completedDateTime""
  • envelope{}
  • envelopeId"e1"
  • recipients{}
  • sentDateTime""
  • status"sent"
  • statusChangedDateTime""

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

DocuSign errors

15 codes

Common errors

93 codes

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "envelopeId": "<envelope id>",
    "include": "recipients"
  },
  "label": "Get envelope",
  "type": "docusign.getEnvelope",
  "version": 1
}