List All Retention Policies
List All Retention Policies
To list all Retention Policies that have been created in an enterprise, call
the GET /retention_policies
API endpoint.
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' }
*/
});
Required Scopes
Before using any of the Retention Policy APIs, an application must have the right scopes enabled. See Required Scopes for more details.