Flag (global)

Represents a single flag set up in the system. For a flag assigned to a specific application, see Flag.

URI
/api/v9/applications/flags/ID

Get a flag

Use the HEAD verb to test if this flag exists. A request with the GET verb returns some additional information about the flag (e.g created date).

Syntax
GET /api/v9/applications/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications/flags/1"

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

Response code	Description
`200 OK`	The flag data was successfully returned
`404 Not Found`	The flag does not exist

Response
{
  "id": 1,
  "created": "2025-03-14T13:28:51+00:00",
  "name": "Awaiting interview"
}

Remove the flag from the system, also removing it from all applications.

Syntax
DELETE /api/v9/applications/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Request
curl
curl \
  -X DELETE \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications/flags/1"

Header	Value	Description
`Content-Type`	`text/plain`	Media type of the resource
`Content-Length`	`0`	Size of the response body in bytes

Response code	Description
`204 No Content`	The flag was successfully deleted
`404 Not Found`	The flag was not found