Skip to main content
GET
/
v1
/
knowledge-base
/
retention-policy
Get the org's KB audit retention policy (creates defaults if unset)
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retention_days": 123,
  "legal_hold_enabled": true,
  "archive_before_delete": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "legal_hold_reason": "<string>",
  "legal_hold_set_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legal_hold_set_at": "2023-11-07T05:31:56Z",
  "archive_destination": "<string>",
  "policy_version": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

Successful Response

Org audit-retention policy + legal-hold state.

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
retention_days
integer
required
​
legal_hold_enabled
boolean
required
​
archive_before_delete
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
legal_hold_reason
string | null
​
legal_hold_set_by
string<uuid> | null
​
legal_hold_set_at
string<date-time> | null
​
archive_destination
string | null
​
policy_version
string | null