Skip to main content
DocuSign logo

​
Overview

Add DocuSign to any ModuleX agent or workflow. Electronic signature and agreement management via the DocuSign eSignature REST API (account.docusign.com + per-account base URIs resolved at runtime).
Categories: Productivity & Collaboration · Legal · E Signature · Document Management · Auth: OAuth2 · Actions: 12

​
Authentication

​
OAuth2 Authentication

Connect using DocuSign OAuth (recommended)

​
Required Credentials

FieldDescriptionRequiredFormat
Client IDDocuSign OAuth App Integration Key (Client ID)Yesxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Client SecretDocuSign OAuth App Secret KeyYesxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
OAuth Configuration

  • Authorization URL: https://account.docusign.com/oauth/auth
  • Token URL: https://account.docusign.com/oauth/token
  • Scopes: signature, extended

​
Available Actions

​
Parameters

​
account
string
required
DocuSign Account ID
​
template
string
required
Document Template ID
​
email_subject
string
required
Subject line of the signature request email
​
email_blurb
string
Email message body to the recipient. Overrides the template setting
​
template_roles_json
string
JSON array of template role objects, each with roleName, name, and email. Example: [{“roleName”:“Signer 1”,“name”:“Jane”,“email”:“jane@example.com”}]

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Envelope Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "status_date_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Date Time"
    },
    "uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uri"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateSignatureRequestOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
template
string
required
Document Template ID
​
email_subject
string
required
Subject line of the email
​
email_blurb
string
Email message body to the recipient. Overrides the template setting
​
template_roles_json
string
JSON array of template role objects, each with roleName, name, and email

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Envelope Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "status_date_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Date Time"
    },
    "uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uri"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateDraftOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_definition_json
string
required
Full DocuSign envelope definition as a JSON string. Example: {“emailSubject”:“Please sign”,“status”:“sent”,“documents”:[…],“recipients”:{“signers”:[…]}}
​
status
string
Envelope status override. Use ‘created’ to save as draft or ‘sent’ to send immediately. Allowed values: sent, created
​
merge_roles_on_draft
boolean
When creating a draft from multiple templates, merge template roles and remove empty recipients

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Envelope Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "status_date_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Date Time"
    },
    "uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uri"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateEnvelopeOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
file_url
string
required
URL of the document to send. The file will be fetched and base64-encoded for upload to DocuSign
​
email_subject
string
required
Subject line of the email
​
signer_name
string
required
Full name of the signer
​
signer_email
string
required
Email address of the signer
​
status
string
Use ‘sent’ to send immediately or ‘created’ to save as draft. Allowed values: sent, created (Default: sent)
​
document_name
string
Document name shown in DocuSign. Defaults to the filename from the URL
​
file_extension
string
File extension. Defaults to the extension from the URL, or ‘pdf’ if not detected
​
signer_recipient_id
string
Recipient ID for the signer (Default: 1)
​
routing_order
string
Routing order for the signer (Default: 1)
​
client_user_id
string
Set this for embedded signing recipients. The same value is required when creating a recipient view URL
​
sign_here_anchor_string
string
Anchor text in the document where DocuSign places the signature tab. Example: /sn1/ (Default: /sn1/)
​
anchor_x_offset
string
Horizontal offset in pixels for the signature tab relative to the anchor text (Default: 20)
​
anchor_y_offset
string
Vertical offset in pixels for the signature tab relative to the anchor text (Default: 10)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Envelope Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "status_date_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Date Time"
    },
    "uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uri"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateEnvelopeFromFileOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID
​
return_url
string
required
URL where DocuSign redirects the signer after the signing session. Must include https://
​
recipient_id
string
required
Recipient ID on the envelope
​
authentication_method
string
Convention string describing how your app authenticated the signer. Example: none (Default: none)
​
ping_url
string
URL DocuSign pings while the signing session is active
​
ping_frequency
string
Ping interval in seconds. DocuSign supports 60 to 1200

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateRecipientViewOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID
​
include
string
Comma-separated additional information to include. Allowed values: custom_fields, documents, extensions, folders, recipients, tabs

​
Response

{
  "$defs": {
    "EnvelopeSummary": {
      "additionalProperties": false,
      "properties": {
        "envelope_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Envelope Id"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "email_subject": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Subject"
        },
        "status_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status Date Time"
        },
        "uri": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Uri"
        },
        "sender_user_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sender User Name"
        },
        "sender_email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sender Email"
        },
        "created_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created Date Time"
        },
        "sent_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sent Date Time"
        },
        "completed_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Completed Date Time"
        },
        "voided_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Voided Date Time"
        },
        "voided_reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Voided Reason"
        }
      },
      "title": "EnvelopeSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope": {
      "anyOf": [
        {
          "$ref": "#/$defs/EnvelopeSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetEnvelopeOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
from_date
string
Return envelopes changed on or after this ISO 8601 datetime, e.g. 2026-04-01T00:00:00Z. Defaults to 30 days ago
​
to_date
string
Return envelopes changed on or before this ISO 8601 datetime
​
status
string
Comma-separated envelope statuses. Allowed values: any, completed, created, declined, deleted, delivered, processing, sent, signed, timedout, voided
​
email
string
Filter by recipient or sender email address
​
search_text
string
Search text matched against envelope metadata
​
folder_ids
string
Comma-separated folder IDs to filter by
​
count
integer
Number of envelopes per page (Default: 100)
​
start_position
integer
Zero-based result offset (Default: 0)
​
order
string
Sort order. Allowed values: asc, desc
​
order_by
string
Field to sort by. Allowed values: action_required, created, completed, sent, signer_list, status, subject, last_modified
​
fetch_all
boolean
When true, follow pagination until no pages remain or max_pages is reached (Default: false)
​
max_pages
integer
Maximum pages to retrieve when fetch_all is true (Default: 10)

​
Response

{
  "$defs": {
    "EnvelopeSummary": {
      "additionalProperties": false,
      "properties": {
        "envelope_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Envelope Id"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "email_subject": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Subject"
        },
        "status_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status Date Time"
        },
        "uri": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Uri"
        },
        "sender_user_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sender User Name"
        },
        "sender_email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sender Email"
        },
        "created_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created Date Time"
        },
        "sent_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Sent Date Time"
        },
        "completed_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Completed Date Time"
        },
        "voided_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Voided Date Time"
        },
        "voided_reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Voided Reason"
        }
      },
      "title": "EnvelopeSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelopes": {
      "items": {
        "$ref": "#/$defs/EnvelopeSummary"
      },
      "title": "Envelopes",
      "type": "array"
    },
    "result_set_size": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result Set Size"
    },
    "total_set_size": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Set Size"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListEnvelopesOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID
​
include_tabs
boolean
Whether to include tab information for each document (Default: false)
​
include_metadata
boolean
Whether to include document metadata (Default: false)

​
Response

{
  "$defs": {
    "DocumentSummary": {
      "additionalProperties": false,
      "properties": {
        "document_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Document Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        },
        "uri": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Uri"
        },
        "order": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Order"
        },
        "pages": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Pages"
        }
      },
      "title": "DocumentSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "documents": {
      "items": {
        "$ref": "#/$defs/DocumentSummary"
      },
      "title": "Documents",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListDocumentsOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID
​
include_tabs
boolean
Whether to include each recipient’s tabs (Default: false)
​
include_extended
boolean
Whether to include extended recipient information (Default: false)
​
include_metadata
boolean
Whether to include metadata (Default: false)

​
Response

{
  "$defs": {
    "RecipientSummary": {
      "additionalProperties": false,
      "properties": {
        "recipient_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recipient Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "routing_order": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Routing Order"
        },
        "client_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Client User Id"
        },
        "signed_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Signed Date Time"
        },
        "delivered_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Delivered Date Time"
        }
      },
      "title": "RecipientSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "signers": {
      "items": {
        "$ref": "#/$defs/RecipientSummary"
      },
      "title": "Signers",
      "type": "array"
    },
    "carbon_copies": {
      "items": {
        "$ref": "#/$defs/RecipientSummary"
      },
      "title": "Carbon Copies",
      "type": "array"
    },
    "agents": {
      "items": {
        "$ref": "#/$defs/RecipientSummary"
      },
      "title": "Agents",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListRecipientsOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Envelope Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendEnvelopeOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID
​
download_type
string
required
Download type. Allowed values: combined (All Documents PDF), archive (All Documents Zip), certificate (Certificate PDF), portfolio (Portfolio PDF)
​
filename
string
required
Filename including extension (.pdf or .zip) for the downloaded content

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "content_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Base64"
    },
    "filename": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Filename"
    },
    "content_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Type"
    }
  },
  "required": [
    "success"
  ],
  "title": "DownloadDocumentsOutput",
  "type": "object"
}

​
Parameters

​
account
string
required
DocuSign Account ID
​
envelope_id
string
required
DocuSign envelope ID
​
voided_reason
string
required
Reason the envelope is being voided. Visible in DocuSign audit history

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "envelope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Envelope Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    }
  },
  "required": [
    "success"
  ],
  "title": "VoidEnvelopeOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limits: DocuSign enforces per-account rate limits; the eSignature REST API allows approximately 1,000 requests per 15 minutes for production accounts. Demo/sandbox accounts have lower limits.
  • Polling intervals: For envelope status polling, DocuSign recommends no more than once per 15 minutes.
  • File size: Maximum document size is 25 MB per document.
  • Error model: Non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Plan for retries on the agent side based on the error string.

Cal.com

Canva

ConvertAPI