Skip to navigation

Retrieve the retention window

View as Markdown

Returns how long the workspace keeps its data, as the daily sweep will apply it tonight:

  • retentionDays: the row window you set with PUT /api/compliance/retention. When it has never been set, the value is 365.
  • contentRetentionDays: the shorter window after which transcripts, message bodies and summaries are blanked. It is the smaller of retentionDays and the plan cap (tierCapDays).

Use it to answer “how long do you keep our data?” in a security questionnaire. Run the sweep now with POST /api/compliance/retention/enforce.

Consistency. Not cached, so the value is always current.

Access

  • Required scope: read or write. Any signed-in workspace role.
  • Rate limit: General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See Rate limits.
  • Plan: Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Response

Retention window.
dataobject
How long the workspace keeps data, as the daily sweep applies it.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error