Box Developer Documentation
Log in
Latest version

List file version retentions

get
https://api.box.com/2.0
/file_version_retentions

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieves all file version retentions for the given enterprise.

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.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryoptional
permanently_delete

Filters results by the retention policy with this disposition action.

Value is one of permanently_delete,remove_retention

stringin queryoptional
2012-12-19T10:34:23-08:00

Filters results by files that will have their disposition come into effect after this date.

stringin queryoptional
2012-12-12T10:53:43-08:00

Filters results by files that will have their disposition come into effect before this date.

stringin queryoptional
43123123

Filters results by files with this ID.

stringin queryoptional
1

Filters results by file versions with this ID.

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

stringin queryoptional
982312

Filters results by the retention policy with this ID.

Response

application/jsonFile version retentions

Returns a list of all file version retentions for the enterprise.

application/jsonClient error

An unexpected client error.

get
List file version retentions
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/file_version_retentions" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileVersionRetentions.getFileVersionRetentions();
Python Gen
client.file_version_retentions.get_file_version_retentions()
.NET Gen
await client.FileVersionRetentions.GetFileVersionRetentionsAsync();
Swift Gen (Beta)
try await client.fileVersionRetentions.getFileVersionRetentions()
Java
BoxFileVersionRetention.QueryFilter filter = new BoxFileVersionRetention.QueryFilter()
                .addFileID("0")
                .addFileVersionID("1")
                .addPolicyID("2")
                .addDispositionAction(BoxRetentionPolicy.ACTION_PERMANENTLY_DELETE)
                .addDispositionBefore(BoxDateFormat.parse("2016-09-15T13:15:35+0000"))
                .addDispositionAfter(BoxDateFormat.parse("2014-09-15T13:15:35+0000"));
Iterable<BoxFileVersionRetention.Info> retentions
                = BoxFileVersionRetention.getRetentions(api, filter, "file", "applied_at");
for (BoxFileVersionRetention.Info retentionInfo : retentions) {
	// Do something with the file version retention.
}
Python
retentions = client.get_file_version_retentions()
for retention in retentions:
    print(f'The file version retention ID is {retention.id} and the data time applied at is {retention.applied_at}')
.NET
BoxCollectionMarkerBased<BoxFileVersionRetention> retentions = await client.RetentionPoliciesManager
    .GetFileVersionRetentionsAsync();
Node
// Get only the retention records set to delete items before a certain date
var options = {
	disposition_action:
		client.retentionPolicies.dispositionActions.PERMANENTLY_DELETE,
	disposition_before: '2038-01-01T12:34:56-08:00',
};
client.retentionPolicies
	.getAllFileVersionRetentions(options)
	.then((retentions) => {
		/* retentions -> {
			entries:
			[ { type: 'file_version_retention', id: '112725' },
				{ type: 'file_version_retention', id: '112729' },
				{ type: 'file_version_retention', id: '112733' } ],
			limit: 100,
			order: [ { by: 'file_version_id', direction: 'ASC' } ] }
		*/
	});
iOS
let iterator = client.files.listVersionRetentions()
iterator.next { results in
    switch results {
    case let .success(page):
        for retention in page.entries {
            print("File version retention \(retention.id)")
        }
        
    case let .failure(error):
        print(error)
    }
}

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"
}