List retention policy rows

Settings module

GET/retention-policiesretentionPolicies.list

Retention of soft-deleted rows per table. Returns a cursor page of retention policy rows the caller may see. The default order is `table_name` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability data.retention.write.
OAuth scopes: data.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

retentionPolicies.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of RetentionPolicy

retentionPolicies.list: RetentionPolicy
Field	Type	Required	Description
table_name	string	Yes	Table.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
basis	"Soft Deleted" \| "Age" \| null	Yes	What starts the retention clock.
time_column	string \| null	Yes	Column that starts the clock.Constraints: length 1 to 300
retention	string \| null	Yes	How long rows are kept, as an interval.Constraints: length 1 to 300
purge_method	"Delete" \| "Drop Partition" \| "Account Lifecycle" \| null	Yes	How expired rows leave.
redact_personal_data_after	string \| null	Yes	When personal data in the table is redacted, if ever.Constraints: length 1 to 300
rationale	string \| null	Yes	Why the period was chosen.Constraints: length 1 to 2000

{
  "data": [
    {
      "table_name": "app.activity_events",
      "basis": "Soft Deleted",
      "time_column": "deleted_at",
      "retention": "7 years",
      "purge_method": "Delete",
      "redact_personal_data_after": "90 days",
      "rationale": "Tax records are kept seven years."
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/retention-policies" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.retentionPolicies.listAll()) {
  console.log(row);
}

for row in xos.retention_policies.list_all():
    print(row)

xos retention-policies list --all