Skip to main content
GET
/
file_version_retentions
/
{file_version_retention_id}
cURL
curl -i -X GET "https://api.box.com/2.0/file_version_retentions/3424234" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "id": "11446498",
  "type": "file_version_retention",
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "file": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "winning_retention_policy": {
    "id": "12345",
    "type": "retention_policy",
    "policy_name": "Some Policy Name",
    "retention_length": "365",
    "disposition_action": "permanently_delete"
  }
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_version_retention_id
string
required

The ID of the file version retention.

Response

Returns a file version retention object.

A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key in your application management console.

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.

​
id
string

The unique identifier for this file version retention.

Example:

"11446498"

​
type
enum<string>

The value will always be file_version_retention.

Available options:
file_version_retention
Example:

"file_version_retention"

​
file_version
File version (Mini) · object

The file version this file version retention was applied to.

​
file
File (Mini) · object

The file this file version retention was applied to.

​
applied_at
string<date-time>

When this file version retention object was created.

Example:

"2012-12-12T10:53:43-08:00"

​
disposition_at
string<date-time>

When the retention expires on this file version retention.

Example:

"2012-12-12T10:53:43-08:00"

​
winning_retention_policy
Retention policy (Mini) · object

The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.