List Attachments (GET /v2.0/envelopes/{envelopeId}/list_supporting_document)
Get a list of attachments by Enveloope ID.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Query String Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelope ID |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | List of attached files |
Response Body Data Fields
| Field | Always Present | Notes |
|---|---|---|
| supporting_document_id | Yes | Attachment ID of attached document |
| file_name | Yes | Attachment name of attached document |
Sample Success Response
REQUEST:
curl --location --request GET '/api/v2.0/envbelopes/6a4e4fd3-e4c7-41ed-a15e-a4e0f9867c12/list_supporting_document' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"message": "",
"data": [
{
"supporting_document_id": "fc284121-1d1f-4251-b87d-c14ab6e50bd7",
"file_name": "attchment.pdf"
}
]
}
Sample Error Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/6a4e4fd3-e4c7-41ed-a15e-a4e0f9867c12/list_supporting_document' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"error_code": "DOCUMENT_NOT_FOUND_OR_RECIPIENT_NO_ACCESS",
"developer_message": "The requested envelope is not found or recipient does not have permission to access envelope."
}
]
Note: View the full list of applicable error code for this method here.