Offer attachments

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

Represents a list of offer attachments.

URI
/api/v10/applications/ID/offers/ID/attachments

List offer attachments

List all attachments currently associated with an offer.

If an attachment is generated from a letterhead, the API request also returns the letterhead ID.

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

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

This API request does not return attachments themselves, only the attachment metadata. Each actual blob can be downloaded individually using the offer attachment download.

Syntax
GET /api/v10/applications/123/offers/321/attachments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

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

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1456`	The size of the response body in bytes
`X-Count`	`2`	The number of attachments for this offer

Response codes

Response code	Description
`200 OK`	The list of offer attachments was successfully returned

Example response

Response
{
  "100": {
    "id": 100,
    "letterhead": "/api/v10/letterheads/10",
    "download": "/api/v10/applications/123/offers/321/attachments/100/download"
  },
  "101": {
    "id": 101,
    "letterhead": "/api/v10/letterheads/20",
    "download": "/api/v10/applications/123/offers/321/attachments/101/download"
  },
  "102": {
    "id": 102,
    "download": "/api/v10/applications/123/offers/321/attachments/102/download"
  }
}