List All Legal Hold Policies
List All Legal Hold Policies
To list all Legal Hold Policies that have been created in an enterprise, call
the GET /legal_hold_policies
API endpoint.
cURL
curl -i -X GET "https://api.box.com/2.0/legal_hold_policies" \
-H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.legalHoldPolicies.getLegalHoldPolicies();
Python Gen
client.legal_hold_policies.get_legal_hold_policies()
.NET Gen
await client.LegalHoldPolicies.GetLegalHoldPoliciesAsync();
Swift Gen (Beta)
try await client.legalHoldPolicies.getLegalHoldPolicies()
Java
Iterable<BoxLegalHoldPolicy.Info> policies = BoxLegalHoldPolicy.getAll(api);
for (BoxLegalHoldPolicy.Info policyInfo : policies) {
// Do something with the legal hold policy.
}
Python
policies = client.get_legal_hold_policies()
for policy in policies:
print(f'Legal Hold Policy "{policy.name}" has ID {policy.id}')
.NET
BoxCollectionMarkerBased<BoxLegalHoldPolicy> policies = await client.LegalHoldPoliciesManager
.GetListLegalHoldPoliciesAsync();
Node
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' } ] }
*/
});
iOS
let iterator = client.legalHolds.listForEnterprise(policyName: "policy1")
iterator.next { results in
switch results {
case let .success(page):
for policy in page.entries {
print("Legal hold policy \(policy.name)")
}
case let .failure(error):
print(error)
}
}
Required Scopes
Before using any of the Legal Hold APIs, an application must have the right scopes enabled. See Required Scopes for more details.