ZIP archive

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a ZIP archive with all documents attached to a task.

URI
/api/v9/applications/ID/tasks/ID/documents/zip

Download attached documents

Retrieve all documents attached to a task as a ZIP archive (binary data).

DreamApply organizes the ZIP archive using the following rules:

Task status: DreamApply retrieves documents attached to both active and trashed tasks.
Duplicate file names: If multiple files have the same name, DreamApply appends a unique suffix to differentiate them.
PDF previews: For PDF files with 9 or fewer pages, DreamApply automatically generates JPEG previews — one preview file per PDF page. By default, the ZIP archive includes both the original PDF files and previews. To download only the original PDF files without previews, use the skip-extracted-pages parameter.

You can also download all documents attached to an application. For details, see GET /api/v9/applications/ID/documents/zip.

Syntax
GET /api/v9/applications/123/tasks/321/documents/zip
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name	Required/Optional	Description	Notes
`skip-extracted-pages`	Optional	Set to `true` to exclude automatically generated JPEG previews from the ZIP archive and retrieve only the original PDF files.

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  -o ~/Downloads/task_321.zip \
  "https://apply.example.edu/api/v9/applications/123/tasks/321/documents/zip?skip-extracted-pages=true"

Response headers

Header	Value	Description
`Content-Type`	`application/zip`	Media type of the resource

Response codes

Response code	Description
`200 OK`	The binary data of the ZIP archive was successfully returned
`404 Not Found`	The task was not found

Documents

Document