Skip to main content
API version 2024.0 A list of retention policies.
​
entries
Retention policyarray
A list in which each entry represents a retention policy object.
​
limit
integer(int64)
example: 1000The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
​
next_marker
string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiThe marker for the start of the next page of results.
{
  "entries": [
    {
      "id": "12345",
      "type": "retention_policy",
      "disposition_action": "permanently_delete",
      "policy_name": "Some Policy Name",
      "retention_length": "365",
      "are_owners_notified": false,
      "assignment_counts": {
        "enterprise": 1,
        "folder": 1,
        "metadata_template": 1
      },
      "can_owner_extend_retention": false,
      "created_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "login": "[email protected]",
        "name": "Aaron Levie"
      },
      "custom_notification_recipients": [
        {
          "id": "11446498",
          "type": "user",
          "login": "[email protected]",
          "name": "Aaron Levie"
        }
      ],
      "description": "Policy to retain all reports for at least one month",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "policy_type": "finite",
      "retention_type": "non_modifiable",
      "status": "active"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}