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 an application.

URI
/api/v10/applications/ID/documents/zip

Download attached documents

Download all documents attached to an application as a ZIP archive (binary data).

DreamApply organizes the ZIP archive using the following rules:

Source retrieval: The archive includes documents uploaded via the Documents section on the application edit page and documents uploaded via tasks (including both active and trashed tasks). Task-related files are placed in folders named after a specific task.
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 files without previews, use the skip-extracted-pages parameter.

You can also download documents attached to a specific task. To do this, use GET api/applications/ID/tasks/ID/documents/zip.

Syntax
GET /api/v10/applications/123/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/application_123.zip \
  "https://apply.example.edu/api/v10/applications/123/documents/zip?skip-extracted-pages=true"

Response headers

Header	Value	Description
`Content-Type`	`application/zip`	The 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 application was not found