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 an application. For a list of flags configured in DreamApply, see Flags (global).

URI
/api/v10/applications/ID/flags

List flags

List flag associations for an application.

This API request does not return the flags themselves. It represents relationships between an application and flags. Follow the flag URI in the response to retrieve further information about a speicific flag.

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

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 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/v10/applications/flags/1"
  },
  "2": {
    "assigned": "2025-12-09T13:26:29+00:00",
    "flag": "/api/v10/applications/flags/2"
  }
}