​
Get Documents List

Get a list of documents associated with the specified envelope as files.

External Documentation

To learn more, visit the Docusign documentation.

​
Parameters

ParameterDescription
Envelope IDThe ID of the envelope.

​
Example Output

{
	"envelopeDocuments": [
		{
			"attachmentTabId": "string",
			"authoritativeCopy": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ",
			"availableDocumentTypes": [
				{
					"isDefault": "string",
					"type": "Type of the user. Valid values: type_owner, type_participant."
				}
			],
			"containsPdfFormFields": "string",
			"display": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`\u003cbr\u003e\n  The document is shown as a supplement action strip\n  and can be viewed, downloaded, or printed in a modal window.\n  This is the recommended value for supplemental documents. \n\n* `download`\u003cbr\u003e\n  The document is shown as a supplement action strip\n  and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`\u003cbr\u003e\n  The document is shown in the normal signing window.\n  This value is not used with supplemental documents,\n  but is the default value for all other documents.\n",
			"documentFields": [
				{
					"errorDetails": {
						"errorCode": "An error code associated with the error.",
						"message": "A short error message."
					},
					"name": "The name or key of a name/value pair.",
					"originalValue": "The initial value of the tab when it was sent to the recipient. ",
					"value": "The value field of a name/value pair."
				}
			],
			"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
			"errorDetails": {
				"errorCode": "An error code associated with the error.",
				"message": "A short error message."
			},
			"includeInDownload": "When set to **true**,\nthe document is included in the combined document download. \nThe default value is **true**.\n",
			"name": "string",
			"order": "An optional value that sets the direction order used to sort the item list. \n\nValid values are: \n\n* asc = ascending sort order\n* desc = descending sort order ",
			"pages": "string",
			"signerMustAcknowledge": "Sets how the signer interacts with the supplemental document.\nThe possible values are: \n\n*\t`no_interaction`\u003cbr\u003e\n  No recipient action is required. \n\n*\t`view`\u003cbr\u003e\n  The recipient is required to view the document. \n\n*\t`accept`\u003cbr\u003e\n  The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. \n\n*\t`view_accept`\u003cbr\u003e\n  The recipient is required to view and accept the document.  \n\n",
			"sizeBytes": "string",
			"type": "Type of the user. Valid values: type_owner, type_participant.",
			"uri": "string"
		}
	],
	"envelopeId": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
}

​
Workflow Library Example

Get Documents List with Docusign and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?