List All Retention Policies

To list all Retention Policies that have been created in an enterprise, call the API endpoint.

cURL

curl -i -X GET "https://api.box.com/2.0/retention_policies" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

await client.retentionPolicies.getRetentionPolicies();

client.retention_policies.get_retention_policies()

await client.RetentionPolicies.GetRetentionPoliciesAsync();

try await client.retentionPolicies.getRetentionPolicies()

client.getRetentionPolicies().getRetentionPolicies()

Iterable<BoxRetentionPolicy.Info> policies = BoxRetentionPolicy.getAll(api);
for (BoxRetentionPolicy.Info policyInfo : policies) {
	// Do something with the retention policy.
}

retention_policies = client.get_retention_policies()
for policy in retention_policies:
    print(f'The policy ID is {policy.id} and the name is {policy.policy_name}')

BoxCollectionMarkerBased<BoxRetentionPolicy> policies = await client.RetentionPoliciesManager
    .GetRetentionPoliciesAsync();

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 for more details.