Offer letter
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 single offer letter.
Syntax
/api/v9/applications/ID/offers/ID/letters/ID
Host: apply.example.edu
Authorization: DREAM apikey="..."GET Get an offer letter
Fetch the metadata associated with an offer attachment. Currently this API request is only provided for the sake of completeness. It is likely easier to fetch the entire list using GET /api/v9/applications/ID/offers/ID/letters as currently this API request does not offer any additional data beyond the data already available in the listing.
Syntax
GET /api/v9/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/v9/applications/123/offers/321/letters/101"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | 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/v9/letterheads/1",
"administrator": null
}