Skip to main content
GET
/
v1
/
audit
/
retention
Get retention policy
curl --request GET \
  --url https://api.truthlocks.com/v1/audit/retention \
  --header 'X-API-Key: <api-key>'
{
  "retention_days": 123,
  "hard_delete": true,
  "export_allowed": true,
  "environment_id": "<string>"
}
Returns the active retention policy for the authenticated tenant. If an environment-specific policy exists, it takes precedence over the global policy. Requires the tenant.audit.retention.read permission.

​
Parameters

​
environment_id
string
Optional. Retrieve the retention policy for a specific environment. If omitted, returns the global policy.

​
Responses

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Query Parameters

​
environment_id
string

Optional environment filter

Response

Retention policy

​
retention_days
integer
​
hard_delete
boolean
​
export_allowed
boolean
​
environment_id
string | null