List legal hold policy assignments


Retrieves a list of items a legal hold policy has been assigned to.



Query Parameters

stringin queryoptional

Filters the results by the ID of item the policy was applied to.

stringin queryoptional

Filters the results by the type of item the policy was applied to.

Value is one of file,file_version,folder,user

string arrayin queryoptional

A 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.

integer / int64in queryoptional

The maximum number of items to return per page.

stringin queryoptional

Defines 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.

stringin queryrequired

The ID of the legal hold policy


Returns a list of legal hold policy assignments.

application/jsonClient error

An unexpected client error.

List legal hold policy assignments
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

curl -i -X GET "" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
BoxCollectionMarkerBased<BoxLegalHoldPolicyAssignment> assignments = await client.LegalHoldPoliciesManager
    .GetAssignmentsAsync(legalHoldPolicyId: "11111");
assignments = client.legal_hold_policy(policy_id='12345').get_assignments()
for assignment in assignments:
    print(f'Found policy assignment with ID {}')
client.legalHoldPolicies.getAssignments('8763245', {assign_to_type: 'folder'})
	.then(assignments => {
		/* assignments -> {
			entries: [ { type: 'legal_hold_policy_assignment', id: '22222' } ],
			limit: 100,
			next_marker: 'someMarkerString' }
let iterator = client.legalHolds.listPolicyAssignments(policyId: "1234") { results in
    switch results {
    case let .success(page):
        for assignment in page.entries {
            print("Policy Assignment \(")

    case let .failure(error):


Response Example

  "entries": [
      "id": "11446498",
      "type": "legal_hold_policy_assignment"
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000