List All Legal Hold Policies

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

cURL

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

await client.legalHoldPolicies.getLegalHoldPolicies();

client.legal_hold_policies.get_legal_hold_policies()

await client.LegalHoldPolicies.GetLegalHoldPoliciesAsync();

try await client.legalHoldPolicies.getLegalHoldPolicies()

client.getLegalHoldPolicies().getLegalHoldPolicies()

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

policies = client.get_legal_hold_policies()
for policy in policies:
    print(f'Legal Hold Policy "{policy.name}" has ID {policy.id}')

BoxCollectionMarkerBased<BoxLegalHoldPolicy> policies = await client.LegalHoldPoliciesManager
    .GetListLegalHoldPoliciesAsync();

client.legalHoldPolicies.getAll({policy_name: 'Important'})
	.then(policies => {
		/* policies -> {
			entries: 
			[ { type: 'legal_hold_policy',
				id: '11111',
				policy_name: 'Important Policy 1' },
				{ type: 'legal_hold_policy',
				id: '22222',
				policy_name: 'Important Policy 2' } ],
			limit: 100,
			order: [ { by: 'policy_name', direction: 'ASC' } ] }
		*/
	});

Required Scopes

Before using any of the Legal Hold APIs, an application must have the right scopes enabled. See for more details.