List legal hold policy assignments

get
https://api.box.com/2.0
/legal_hold_policy_assignments/

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

Request

Bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryoptional
1234323

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

stringin queryoptional
file

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
id,type,name

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
10001000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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
324432

The ID of the legal hold policy

Response

Returns a list of legal hold policy assignments.

application/jsonClient error

An unexpected client error.

get
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
curl -i -X GET "https://api.box.com/2.0/legal_hold_policy_assignments?policy_id=324432" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollectionMarkerBased<BoxLegalHoldPolicyAssignment> assignments = await client.LegalHoldPoliciesManager
    .GetAssignmentsAsync(legalHoldPolicyId: "11111");
Python
assignments = client.legal_hold_policy(policy_id='12345').get_assignments()
for assignment in assignments:
    print('Found policy assignment with ID {0}'.format(assignment.id))
Node
client.legalHoldPolicies.getAssignments('8763245', {assign_to_type: 'folder'})
	.then(assignments => {
		/* assignments -> {
			entries: [ { type: 'legal_hold_policy_assignment', id: '22222' } ],
			limit: 100,
			next_marker: 'someMarkerString' }
		*/
	});
iOS
client.legalHolds.listPolicyAssignments(policyId: "1234") { results in
    switch results {
    case let .success(iterator):
        for i in 1 ... 10 {
            iterator.next { result in
                switch result {
                case let .success(assignment):
                    print("Policy Assignment \(assignment.id)")
                case let .failure(error):
                    print(error)
                }
            }
        }
    case let .failure(error):
        print(error)
    }

}

Response Example

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