Box Developer Documentation
Log in

Retention policies

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

A list of retention policies.

Retention policy array

A list in which each entry represents a retention policy object.

integer (int64)
1000

The 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.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

The marker for the start of the next page of results.

Response Example

{
  "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": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "custom_notification_recipients": [
        {
          "id": "11446498",
          "type": "user",
          "login": "ceo@example.com",
          "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"
}