Read the retention settings

GET
/v1/retention

Returns how long this workspace keeps its conversations and how the trash works: mailRetentionDays (null keeps them), trashRetentionDays, deleteConversationsWithMailbox, permanentDeleteAllowed and legalHold, who decided each (sources), and one plain sentence per setting (lines).

Requires an API key with the retention:manage scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Response Body

The retention settings, who decided each, and what each means now

application/json
  1. response
settings*
sources*
version*integer
Range0 <= value
lines*array<string>
summary*string
Example Request
curl https://api.vlayers.ai/v1/retention \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "settings": {    "mailRetentionDays": null,    "trashRetentionDays": 30,    "deleteConversationsWithMailbox": false,    "permanentDeleteAllowed": true,    "legalHold": false  },  "sources": {    "mailRetentionDays": "platform",    "trashRetentionDays": "platform",    "deleteConversationsWithMailbox": "platform",    "permanentDeleteAllowed": "platform",    "legalHold": "platform"  },  "version": 0,  "lines": [    "Conversations are kept until someone deletes them.",    "A deleted conversation can be brought back for 30 days.",    "Deleting an inbox keeps its conversations.",    "Conversations may be deleted for good.",    "No legal hold: nothing is blocking a permanent delete."  ],  "summary": "Conversations are kept until someone deletes them; the trash holds for 30 days."}