Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::getAttachments

Definitions Expand All | Collapse All

EnvelopeAttachments

accessControl string
attachmentId string
attachmentType string
errorDetails errorDetails
label string
name string

envelopeAttachmentsResult

attachments
[EnvelopeAttachments]

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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>