API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a PDF printout of the application.
URI
/api/v9/applications/ID/pdfGET Generate a PDF printout
Retrieve a PDF printout of the application, replicating the Save as PDF feature in the user interface.
The PDF conversion is happening in real time and may take a few seconds to process on larger applications. The API request is also subject to modest throttling, so you may need to slow down your requests when fetching a large number of PDFs.
Syntax
GET /api/v9/applications/123/pdf
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-o ~/Downloads/application_123.pdf \
"https://apply.example.edu/api/v9/applications/123/pdf"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/pdf | Media type of the resource |
Content-Length | 12345 | Size of the response body in bytes |
Last-Modified | 2025-05-16T14:59:53+00:00 | Date and time when the PDF printout was last modified |
Response codes
| Response code | Description |
|---|---|
200 OK | The PDF printout of the application was successfully generated |