Purged resources

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

Represents a collection of previously existing entities — applicants and applications — that were deleted from the system.

Data purging occurs in the following scenarios:

Applicant account deletion: An applicant requests to delete their account and an Administrator confirms the request, or an Administrator deletes the account directly. For details, see Delete applicant accounts.
Application data purging: An Administrator purges applications for a specific academic term. For details, see Purge applications.

When these resources are deleted, the data is not immediately lost for integrations. DreamApply records the purge event to ensure external systems can stay in sync and update their records accordingly.

You can access purge data via:

The purged-resources endpoint: Use this endpoint to retrieve a list of deleted entities.
The Applicant was deleted journal event: Subscribe to this event using webhooks to receive notifications when a deletion occurs.

URI
/api/v9/purged-resources

Get purged resources

Returns a list of purged entities — applicants and applications.

Syntax
GET /api/v9/purged-resources
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/v9/purged-resources"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`3`	Number of deleted entities

Response codes

Response code	Description
`200 OK`	The response was successfully returned

Example response

Response
{  
    "pages": {
    "total": 1,
    "current": 1,
    "prev": null,
    "next": null,
    "items": {
      "current": 3,
      "total": 3
    }
  },
  "10": {
    "id": 100,
    "type": "Application",
    "created": "2025-05-02T08:15:15+00:00",
    "request_to_be_forgotten": null,
    "marked": {
      "at": "2025-05-02T08:16:25+00:00",
      "by": "/api/v9/administrators/10006"
    },
    "purged": "2025-05-03T02:02:27+00:00"
  },
  "11": {
    "id": 101,
    "type": "Application",
    "created": "2025-05-02T08:17:01+00:00",
    "request_to_be_forgotten": null,
    "marked": {
      "at": "2025-05-02T09:56:56+00:00",
      "by": "/api/v9/administrators/10006"
    },
    "purged": "2025-05-03T02:02:27+00:00"
  },
  "12": {
    "id": 200,
    "type": "Applicant",
    "created": "2025-04-11T07:13:30+00:00",
    "request_to_be_forgotten": null,
    "marked": {
      "at": "2025-05-27T12:38:56+00:00",
      "by": "/api/v9/administrators/10006"
    },
    "purged": "2025-05-28T02:01:51+00:00"
  }
}

Administrators

Ping