List retention policies

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

Retrieves all of the retention policies for an enterprise.

Request

application/json

Query Parameters

stringin queryoptional
21312321

Filters results by the ID of the user who created policy.

stringin queryoptional
Sales Policy

Filters results by a case sensitive prefix of the name of retention policies.

stringin queryoptional
finite

Filters results by the type of retention policy.

Value is one of "finite", "indefinite"

Response

application/jsonRetention Policies

Returns a list retention policies in the enterprise.

application/jsonClient Error

Returns a bad_request if a non existent policy_type was specified.

application/jsonClient Error

Returns a not_found error if the user specified in created_by_user_id does not exist.

You can now try out some of our APIs live, right here in the documentation.
Log In

Request Example

cURL
curl -X GET https://api.box.com/2.0/retention_policies \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollectionMarkerBased<BoxRetentionPolicy> policies = await client.RetentionPoliciesManager
    .GetRetentionPoliciesAsync();
Java
Iterable<BoxRetentionPolicy.Info> policies = BoxRetentionPolicy.getAll(api);
for (BoxRetentionPolicy.Info policyInfo : policies) {
	// Do something with the retention policy.
}
Python
retention_policies = client.get_retention_policies()
for policy in retention_policies:
    print('The policy ID is {0} and the name is {1}'.format(policy.id, policy.policy_name))
Node
client.retentionPolicies.getAll({ policy_name: 'Tax' })
	.then(policies => {
		/* policies -> {
			entries: 
			[ { type: 'retention_policy',
				id: '123456789',
				name: 'Tax Documents' } ],
			limit: 100,
			next_marker: 'someMarkerString' }
		*/
	});

Response Example

{
  "total_count": 156,
  "entries": [
    {
      "id": 12345,
      "type": "file_version",
      "policy_name": "Some Policy Name",
      "retention_length": 0,
      "disposition_action": "permanently_delete"
    }
  ]
}