v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeDocuments

Gets a list of documents in an envelope.

Retrieves a list of documents associated with the specified envelope.

Related topics

  • How to list envelope documents
get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents

Path parameters

accountIdstring required

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

envelopeIdstring required

The envelope's GUID.

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

Query parameters

documents_by_useridstring

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_typestring
include_docgen_formfieldsstring

Reserved for Docusign.

include_is_editedstring
include_metadatastring

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

include_tabsstring

Reserved for Docusign.

recipient_idstring

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_idstring

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

Successful response.