Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

envelopeAttachmentsResult
400

Error encountered.

errorDetails

SDK Method

Envelopes::getAttachments

Definitions

envelopeAttachment

accessControlstring

Valid values are sender and senderAndAllRecipients.

attachmentIdstring

The unique identifier for the attachment.

attachmentTypestring

Specifies the type of the attachment for the recipient. Possible values are:

  • .htm
  • .xml

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

labelstring

namestring

envelopeAttachmentsResult

attachments[envelopeAttachment]

An array of attachment objects that contain information about the attachments.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Response

Response
{
  "attachments": [
    {
      "attachmentId": "sample string 1",
      "label": "sample string 2",
      "attachmentType": "sample string 3",
      "name": "sample string 4",
      "accessControl": "sample string 5",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<envelopeAttachmentsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <attachments>
    <envelopeAttachment>
      <accessControl>sample string 5</accessControl>
      <attachmentId>sample string 1</attachmentId>
      <attachmentType>sample string 3</attachmentType>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <label>sample string 2</label>
      <name>sample string 4</name>
    </envelopeAttachment>
  </attachments>
</envelopeAttachmentsResult> 
}} />