Application statuses

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

Represents a list of all application statuses.

URI
/api/v10/applications/statuses

List application statuses

List all application statuses configured for your instance.

In Browse view of the DreamApply portal, status names are displayed according to their title property. However, when filtering applications by status using GET /api/v10/applications), you must use the actual status names rather than their title property. The status name and the title property often match, but this behavior is not guaranteed.

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

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`	`7`	The number of available application statuses

Response codes

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

Example response

Response
{
  "Blank": {
    "title": "Blank",
    "colour": "#B7E356",
    "verbose": "The application is empty"
  },
  "Draft": {
    "title": "Draft",
    "colour": "#B7E356",
    "verbose": "The application is still a draft"
  },
  "Inactive": {
    "title": "Inactive",
    "colour": "#B7E356",
    "verbose": "The application is still a draft, but apparently not being worked on"
  },
  "Reopened": {
    "title": "Reopened",
    "colour": "#B7E356",
    "verbose": "The application has been reopened"
  },
  "Submitted": {
    "title": "Submitted",
    "colour": "#FFD21F",
    "verbose": "The application has been submitted"
  },
  "Withdrawn": {
    "title": "Withdrawn",
    "colour": "#AFAFAF",
    "verbose": "The application is withdrawn"
  },
  "Closed": {
    "title": "Closed",
    "colour": "#AFAFAF",
    "verbose": "The application is closed"
  }
}