Flags

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

Represents a list of flags assigned to the application. For a list of available flags, see Flags (global).

URI
/api/v9/applications/ID/flags

List flags

Get a list of flag associations for the application in question.

This request does not return the flags themselves, but rather represents the relationships between an application and flags. Follow the flag URI in the response to retrieve further information about the flag in question.

Syntax
GET /api/v9/applications/123/flags
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/flags"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1456`	Size of the response body in bytes
`X-Count`	`2`	Number of flags assigned to the application

Response codes

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

Example response

Response
{
  "1": {
    "assigned": "2025-12-09T13:26:24+00:00",
    "flag": "/api/v9/applications/flags/1"
  },
  "2": {
    "assigned": "2025-12-09T13:26:29+00:00",
    "flag": "/api/v9/applications/flags/2"
  }
}

Courses

Flag