Skip to content
Authrim

Get data retention status.

GET
/api/admin/data-retention/status
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/data-retention/status \
  --header 'Authorization: Bearer <token>'

Returns the tenant data-retention policy snapshot, category statistics, pending deletion summary, and GDPR erasure support status.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Data retention status response.

Media type application/json
object
tenant_id
required
string
policy
required
object
enabled
required
boolean
default_retention_days
required
integer
categories
required
object
key
additional properties
cleanup_schedule
required
string
last_cleanup_run
required
string | null format: date-time
next_cleanup_run
required
string | null format: date-time
key
additional properties
categories
required
Array<object>
object
category
required
string
retention_days
required
integer
total_records
required
integer
records_pending_deletion
required
integer
oldest_record_date
required
string | null format: date-time
next_cleanup_date
required
string | null format: date-time
last_cleanup_date
required
string | null format: date-time
records_deleted_last_30_days
required
integer
hot_query_status
string
key
additional properties
summary
required
object
total_records
required
integer
records_pending_deletion
required
integer
records_deleted_last_30_days
required
integer
storage_savings_estimate_mb
required
number
key
additional properties
gdpr_compliance
required
object
right_to_erasure_supported
required
boolean
anonymization_supported
required
boolean
tombstone_retention_days
required
integer
pending_erasure_requests
required
integer
key
additional properties
last_updated
required
string format: date-time
key
additional properties
Example generated
{
  "tenant_id": "example",
  "policy": {
    "enabled": true,
    "default_retention_days": 1,
    "categories": {
      "additionalProperty": "example"
    },
    "cleanup_schedule": "example",
    "last_cleanup_run": "2026-04-15T12:00:00Z",
    "next_cleanup_run": "2026-04-15T12:00:00Z"
  },
  "categories": [
    {
      "category": "example",
      "retention_days": 1,
      "total_records": 1,
      "records_pending_deletion": 1,
      "oldest_record_date": "2026-04-15T12:00:00Z",
      "next_cleanup_date": "2026-04-15T12:00:00Z",
      "last_cleanup_date": "2026-04-15T12:00:00Z",
      "records_deleted_last_30_days": 1,
      "hot_query_status": "example"
    }
  ],
  "summary": {
    "total_records": 1,
    "records_pending_deletion": 1,
    "records_deleted_last_30_days": 1,
    "storage_savings_estimate_mb": 1
  },
  "gdpr_compliance": {
    "right_to_erasure_supported": true,
    "anonymization_supported": true,
    "tombstone_retention_days": 1,
    "pending_erasure_requests": 1
  },
  "last_updated": "2026-04-15T12:00:00Z"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}