Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Get legal hold policy
Retrieve a legal hold policy.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
324432The ID of the legal hold policy
Response
application/jsonLegal hold policy
Returns a legal hold policy object.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/legal_hold_policies/324432" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId);Python Gen
client.legal_hold_policies.get_legal_hold_policy_by_id(legal_hold_policy_id).NET Gen
await client.LegalHoldPolicies.GetLegalHoldPolicyByIdAsync(legalHoldPolicyId: legalHoldPolicyId);Swift Gen (Beta)
try await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId: legalHoldPolicyId)Java
BoxLegalHoldPolicy policy = new BoxLegalHoldPolicy(api, id);
BoxLegalHoldPolicy.Info policyInfo = policy.getInfo();Python
legal_hold_policy = client.legal_hold_policy(policy_id='12345').get()
print(f'The "{legal_hold_policy.policy_name}" policy is {legal_hold_policy.status}').NET
BoxLegalHoldPolicy policy = await client.LegalHoldPoliciesManager.GetLegalHoldPolicyAsync("11111");Node
client.legalHoldPolicies.get('11111')
.then(policy => {
/* policy -> {
type: 'legal_hold_policy',
id: '11111',
policy_name: 'IRS Audit',
description: '',
status: 'active',
assignment_counts: { user: 1, folder: 0, file: 0, file_version: 0 },
created_by:
{ type: 'user',
id: '22222',
name: 'Example User',
login: 'user@example.com' },
created_at: '2016-05-18T10:28:45-07:00',
modified_at: '2016-05-18T11:25:59-07:00',
deleted_at: null,
filter_started_at: '2016-05-17T01:00:00-07:00',
filter_ended_at: '2016-05-21T01:00:00-07:00' }
*/
});iOS
client.legalHolds.get(policyId: "22222", fields: ["name", "created_at"]) { (result: Result<LegalHoldPolicy, BoxSDKError>) in
guard case let .success(policy) = result else {
print("Error getting policy information")
return
}
print("Legal hold policy \(policy.id) was created at \(policy.createdAt)")
}Response Example
{
"id": "11446498",
"type": "legal_hold_policy",
"assignment_counts": {
"file": 3,
"file_version": 4,
"folder": 2,
"user": 1
},
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"deleted_at": "2012-12-12T10:53:43-08:00",
"description": "Postman created policy",
"filter_ended_at": "2012-12-12T10:53:43-08:00",
"filter_started_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_name": "Policy 4",
"release_notes": "Example",
"status": "active"
}