Manage Applications

    List policy's 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

    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"

    integer / int64in queryoptional
    10001000-1000

    The maximum number of items to return per page.

    stringin queryoptional
    JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

    The position marker at which to begin the response.

    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.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -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' }
    		*/
    	});

    Response Example

    {
      "limit": 1000,
      "next_marker": 3000,
      "prev_marker": 1000,
      "entries": [
        {
          "id": 11446498,
          "type": "legal_hold_policy_assignment",
          "legal_hold_policy": {
            "id": 11446498,
            "type": "legal_hold_policy"
          },
          "assigned_to": {
            "id": 11446498,
            "type": "file",
            "sequence_id": 3,
            "etag": 1,
            "name": "Pictures"
          },
          "assigned_by": {
            "id": 11446498,
            "type": "user",
            "name": "Aaron Levie",
            "login": "ceo@example.com"
          },
          "assigned_at": "2012-12-12T10:53:43-08:00",
          "deleted_at": "2012-12-12T10:53:43-08:00"
        }
      ]
    }