Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Envelope Documents

Gets a list of documents in an envelope

GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents

Retrieves a list of documents associated with the specified envelope.

Related topics

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query Parameters

documents_by_userid?string

When true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.

include_agreement_type?string
include_docgen_formfields?string

Reserved for Docusign.

include_is_edited?string
include_metadata?string

When true, the response includes metadata that indicates which properties the sender can edit.

include_tabs?string

Reserved for Docusign.

recipient_id?string

Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this to work.

shared_user_id?string

The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the Docusign Admin console).

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/documents"
{  "envelopeDocuments": [    {      "addedRecipientIds": [        "string"      ],      "agreementType": "string",      "agreementTypeSource": "string",      "attachmentTabId": "string",      "authoritativeCopy": "string",      "availableDocumentTypes": [        {          "isDefault": "string",          "type": "string"        }      ],      "containsPdfFormFields": "string",      "display": "string",      "docGenDocumentStatus": "string",      "docGenErrors": [        {          "errorCode": "string",          "message": "string",          "tagIdentifier": "string"        }      ],      "docGenFormFields": [        {          "connectedObjectDetails": {            "recordId": "string"          },          "defaultValue": "string",          "description": "string",          "filter": "string",          "format": {            "expression": "string",            "locale": "string"          },          "fullyQualifiedPath": "string",          "hidden": "string",          "label": "string",          "name": "string",          "options": [            {              "description": "string",              "label": "string",              "selected": "string",              "value": "string"            }          ],          "order": "string",          "predefinedValidation": "string",          "readOnly": "string",          "required": "string",          "rowValues": [            {              "docGenFormFieldList": [                {}              ]            }          ],          "type": "string",          "validation": {            "errorMessage": "string",            "expression": "string"          },          "value": "string"        }      ],      "documentBase64": "string",      "documentFields": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "name": "string",          "originalValue": "string",          "value": "string"        }      ],      "documentId": "string",      "documentIdGuid": "string",      "documentTemplateId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "hasDigitalSignature": "string",      "includeInDownload": "string",      "isAceGenDocument": "string",      "isDocGenDocument": "string",      "isEdited": "string",      "isExternallyAvailable": "string",      "isFlattened": "string",      "name": "string",      "order": "string",      "pages": [        {          "dpi": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "height": "string",          "imageBytes": "string",          "mimeType": "string",          "pageId": "string",          "sequence": "string",          "width": "string"        }      ],      "signerMustAcknowledge": "string",      "sizeBytes": "string",      "templateLocked": "string",      "templateRequired": "string",      "type": "string",      "uri": "string"    }  ],  "envelopeId": "string"}

Gets the Electronic Record and Signature Disclosure for a specific envelope recipient GET

Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings. To set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.

Deletes documents from a draft envelope DELETE

Deletes one or more documents from an existing envelope that has not yet been completed. To delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition). For example, this request body specifies that you want to delete the document whose `documentId` is "1". ```text { "documents": [ { "documentId": "1" } ] } ``` The envelope status must be one of: - `created` - `sent` - `delivered`