Offer attachment download

Represents a single offer attachment (binary blob).

/api/v10/applications/ID/offers/ID/attachments/ID/download
Host: apply.example.edu
Authorization: DREAM apikey="..."

GET Download an offer attachment

Retrieve a specific offer attachment (as binary data).

In DreamApply, attachments can be created in two ways:

• File uploads: An attachment is uploaded while composing an offer letter. This request returns the uploaded bytes verbatim.
• Letterhead generation: An attachment is generated from a letterhead template.

Attachments can be managed through the following workflows:

• Offer types: You can specify an attachment as part of an offer type configuration. In this case, the file is attached automatically.
• API requests: You can post attachments directly using the API.

Letterheads

Letterheads are document templates used to generate attachments for offers. The generation workflow includes the following steps:

1. DreamApply creates a letter from the letterhead. This letter represents a generated, potentially user-customized document where each template marker is replaced with actual applicant data. The letterhead can be accessed using offer letters.

2. To attach the letter to an offer, DreamApply converts it to a PDF file. The PDF file is attached to the offer as a regular uploaded PDF.

The DreamApply UI automatically manages this process, while the API explicitly exposes the complete underlying data model.

GET /api/v10/applications/123/offers/234/attachments/100/download
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applications/123/offers/321/attachments/100/download"

Response headers

Response codes