List all legal hold policies
Retrieves a list of legal hold policies that belong to an enterprise.
Request
Query Parameters
id,type,nameA comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
10001000The maximum number of items to return per page.
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiDefines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
This requires usemarker to be set to true.
Sales PolicyLimits results to policies for which the names start with this search term. This is a case-insensitive prefix.
Response
Returns a list of legal hold policies.
An unexpected client error.
Request Example
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()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' } ] }
*/
});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)
}
}Response Example
{
"entries": [
{
"id": "11446498",
"type": "legal_hold_policy",
"policy_name": "Policy 4",
"description": "Postman created policy",
"status": "active",
"assignment_counts": {
"user": 1,
"folder": 2,
"file": 3,
"file_version": 4
},
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"deleted_at": "2012-12-12T10:53:43-08:00",
"filter_started_at": "2012-12-12T10:53:43-08:00",
"filter_ended_at": "2012-12-12T10:53:43-08:00",
"release_notes": "Example"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}