Consent

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

Represents a specific consent associated with an applicant. For a specific consent configured in DreamApply, see Consent (global).

URI
/api/v10/applicants/ID/consents/ID

Get an associated consent

Retrieve information about a specific consent associated with an applicant.

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

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

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

Response codes

Response code	Description
`200 OK`	The consent association is found
`400 Bad Request`	The consent ID was not valid
`404 Not Found`	The applicant has not acted on this consent
`404 Not Found`	The consent was not found

Example response

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