Consents

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

Represents a list of consents associated with an applicant. For a list of consents configured in DreamApply, see Consents (global).

URI
/api/v10/applicants/ID/consents

List associated consents

List all consents associated with an applicant.

This API request does not return the consents themselves. It represents relationships between an applicant and consents. Follow the consent URI in the response to retrieve further information about a specific consent.

Syntax
GET /api/v10/applicants/123/consents
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/applicants/123/consents"

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`	`2`	The number of returned consents

Response codes

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

Example response

Response
{
  "1": {
    "decided": "2025-08-05T12:13:02+00:00",
    "decision": "Accept",
    "consent": "/api/v10/applicants/consents/1"
  },
  "2": {
    "decided": "2025-11-24T12:07:18+00:00",
    "decision": "Reject",
    "consent": "/api/v10/applicants/consents/2"
  }
}