API Reference

Download task related files

get
https://api.dottedsign.com/v1/sign_tasks/download

Download task related files into a zip file.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

File Size Limit

The API Gateway has a payload size limit. If your ZIP file exceeds this limit, you can use the [Get Task Download Link] API to retrieve a download link.

📑

Download Source Files

If source_file is specified in file_types, the response will include only the files that the user has permission to access.
Additionally, individually signed files will only be included after the task has been completed.

Allow authentication via Bearer Token or JWT Code.

scope: sign_tasks.download.read
available user plans: all

Query Params
integer
required

Task ID.

file_types[]
array of strings

File types.
Available file types include task, attachment, attachment_compressed, audit_trail, and source_file.

file_types[]
Headers
string

JWT code for quick sign authentication, same as the code in response of the Get the share link API.

string

OAuth2 Bearer token.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/zip
application/json

Updated 2 months ago

Did this page help you?