retentionEvents

Retention Event Triggers. Events that start event-based retention timers. The retentionEvents entity set lives under /exchange/v1.0/retentionEvents in the Governance & protection category.

Fact	Value
Path	/exchange/v1.0/retentionEvents
Category	Governance & protection
Tier	Tier 5, Compliance
Read role	Compliance.IPPS.Read.All (Community)
Write role	none (read-only)
Backing cmdlets	Get-RetentionEvent

Routes

Method	Path	Synopsis	Role	Plan
GET	/exchange/v1.0/retentionEvents	List retentionEvents entries.	Compliance.IPPS.Read	Community
GET	/exchange/v1.0/retentionEvents/{key}	Get a single retentionEvents entry by Identity.	Compliance.IPPS.Read	Community

GET /exchange/v1.0/retentionEvents

List retentionEvents entries.

Backing cmdlet: Get-RetentionEvent. Role: Compliance.IPPS.Read (Community).

Parameter	In	Type	Required	Description
allStatus	query	bool (switch)		Include events of all statuses (default returns only active).

List retentionEvents - tenant capability gate (500)

List event-based retention triggers via Get-RetentionEvent. Some tenants refuse execution with ‘This command is not allowed to run in Exchange Online Protection environment.’ even though the cmdlet IS imported and recognized - it’s a tenant-side context gate, not a bug in the API. The route ships - the canonical ExchangeCommandFailed envelope surfaces the underlying cmdlet error so callers can distinguish a tenant gap from an API bug. Tenants with proper retention-event scope will get HTTP 200 with the actual events.

GET /exchange/v1.0/retentionEvents HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 500 Internal Server Error

{
  "error": {
    "code": "ExchangeCommandFailed",
    "message": "Cmdlet 'Get-RetentionEvent' failed: This command is not allowed to run in Exchange Online Protection environment.",
    "target": null,
    "innerError": {
      "cmdlet": "Get-RetentionEvent"
    }
  },
  "correlationId": "0HNLQCIKIQ50I:00000001"
}

Related: GET /exchange/v1.0/retentionCompliancePolicies

GET /exchange/v1.0/retentionEvents/{key}

Get a single retentionEvents entry by Identity.

Backing cmdlet: Get-RetentionEvent. Role: Compliance.IPPS.Read (Community).