Offer letter

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

Represents a single offer letter.

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

Get an offer letter

Retrieve the metadata associated with an offer attachment.

This API request is provided only for the sake of completeness. Typically, you will retrieve the entire list of offers using GET /api/v10/applications/ID/offers/ID/letters, as this request does not provide additional data beyond what is already available in the listing.

Syntax
GET /api/v10/applications/123/offers/321/letters/101
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/letters/101"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1234`	The size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The letter data was successfully returned
`404 Not Found`	The letter was not found

Example response

Response
{
  "id": 1,
  "rendered": "2025-01-02T15:44:09+00:00",
  "letterhead": "/api/v10/letterheads/1",
  "administrator": null
}