Sample - Box Platform API
GET/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}

Get a legal hold policy assignment

Retrieves a specific legal hold policy assignment by its identifier. Use legal_hold_policy_assignment_id to identify the assignment linking a legal hold policy to an applicable entity. The response includes the policy, assigned entity, assigning user, assignment time, and deletion time.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
legal_hold_policy_assignment_idstringrequired
The unique identifier of the legal hold policy assignment to retrieve.

2 status codes
200Returns a legal hold policy assignment object containing its identifier, linked legal hold policy, assigned entity, assigning user, assignment timestamp, and deletion timestamp.
idstringoptional
The unique identifier for this legal hold assignment.
typestringoptional
The value will always be `legal_hold_policy_assignment`.
Allowed:legal_hold_policy_assignment
legal_hold_policyobjectoptional
assigned_toobjectoptional
assigned_byobjectoptional
assigned_atstringoptional
When the legal hold policy assignment object was created.
deleted_atstringoptional
When the assignment release request was sent. (Because it can take time for an assignment to fully delete, this isn't quite the same time that the assignment is fully deleted). If null, Assignment was not deleted.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

legal_hold_policy_assignment_id must identify an existing legal hold policy assignment.