Flags (global)
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 list of flags configured in DreamApply. For a list of flags assigned to a specific application, see Flags.
URI
/api/v10/applications/flagsGET List flags
List all flags configured in DreamApply.
Syntax
GET /api/v10/applications/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/flags"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
X-Count | 10 | The number of available flags |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of flags was successfully returned |
Example response
Response
{
"1": {
"id": 1,
"created": "2025-03-14T13:28:51+00:00",
"name": "Awaiting interview"
},
"2": {
"id": 2,
"created": "2025-03-14T13:29:03+00:00",
"name": "Incomplete application"
},
"3": {
"id": 3,
"created": "2025-03-14T13:29:18+00:00",
"name": "Special consideration"
}
}POST Create a flag
Add a new flag to the list of flags in DreamApply.
If a flag with the specified name already exists, the request returns the 409 Conflict error and includes the URI of the existing flag in the Location header.
This API request creates a new flag, but does not assign it to applications. Use PUT /api/v10/applications/ID/flags/ID to assign the created flag to any number of applications.
Syntax
POST /api/v10/applications/flags
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description |
|---|---|---|
name | Required | The text to be displayed on the flag. The allowed length is up to 32 characters. |
Example request
Request
curl
curl \
-X POST \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applications/flags?name=Early%20applicant"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Location | /api/applications/flags/123 | The URI of the created flag |
Response codes
| Response code | Description |
|---|---|
201 Created | A new flag was successfully created |
209 Conflict | A flag with this name already exists |