Ranking

Represents a ranking list created in DreamApply.

URI
/api/v10/rankings/ID

GET Get a ranking

Retrieve information about a specific ranking list.

This request is supported in API version 10 and later.

Syntax
GET /api/v10/rankings/123
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/rankings/123"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonThe media type of the resource
Content-Length1234The size of the response body in bytes

Response codes

Response codeDescription
200 OKThe information about the ranking list was successfully returned
404 Not FoundThe ranking list was not found

Example response

Response
{
  "id": 1,
  "created": "2026-05-20T11:01:02+00:00",
  "modified": "2026-05-20T11:01:02+00:00",
  "title": "Computer Science and Engineering Ranking",
  "offers": "/api/v10/rankings/1/offers"
}