Box Developer Documentation
Log in

File version retentions

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

A list of file version retentions.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

File version retention array

A list of file version retentions

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.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih

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

Response Example

{
  "entries": [
    {
      "applied_at": "2012-12-12T10:53:43-08:00",
      "disposition_at": "2012-12-12T10:53:43-08:00",
      "file": {
        "etag": "1",
        "id": "12345",
        "type": "file",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "name": "Contract.pdf",
        "sequence_id": "3",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
      },
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "id": "11446498",
      "type": "file_version_retention",
      "winning_retention_policy": {
        "id": "12345",
        "type": "retention_policy",
        "disposition_action": "permanently_delete",
        "policy_name": "Some Policy Name",
        "retention_length": "365"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}