Manage Applications

    List all legal hold policies

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

    Retrieves a list of legal hold policies that belong to an enterprise.

    Request

    application/json

    Query Parameters

    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-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 queryoptional
    Sales Policy

    Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.

    Response

    application/jsonLegal Hold Policies

    Returns a list of legal hold policies.

    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_policies \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxCollectionMarkerBased<BoxLegalHoldPolicy> policies = await client.LegalHoldPoliciesManager
        .GetListLegalHoldPoliciesAsync();
    Java
    Iterable<BoxLegalHoldPolicy.Info> policies = BoxLegalHoldPolicy.getAll(api);
    for (BoxLegalHoldPolicy.Info policyInfo : policies) {
        // Do something with the legal hold policy.
    }
    Python
    policies = client.get_legal_hold_policies()
    for policy in policies:
        print('Legal Hold Policy "{0}" has ID {1}'.format(policy.name, policy.id))
    Node
    client.legalHoldPolicies.getAll({policy_name: 'Important'})
    	.then(policies => {
    		/* policies -> {
    			entries: 
    			[ { type: 'legal_hold_policy',
    				id: '11111',
    				policy_name: 'Important Policy 1' },
    				{ type: 'legal_hold_policy',
    				id: '22222',
    				policy_name: 'Important Policy 2' } ],
    			limit: 100,
    			order: [ { by: 'policy_name', direction: 'ASC' } ] }
    		*/
    	});

    Response Example

    {
      "limit": 1000,
      "next_marker": 3000,
      "prev_marker": 1000,
      "entries": [
        {
          "id": 11446498,
          "type": "legal_hold_policy",
          "policy_name": "Policy 4",
          "description": "Postman created policy",
          "status": "active",
          "assignment_counts": {
            "user": 1,
            "folder": 2,
            "file": 3,
            "file_version": 4
          },
          "created_by": {
            "id": 11446498,
            "type": "user",
            "name": "Aaron Levie",
            "login": "ceo@example.com"
          },
          "created_at": "2012-12-12T10:53:43-08:00",
          "modified_at": "2012-12-12T10:53:43-08:00",
          "deleted_at": "2012-12-12T10:53:43-08:00",
          "filter_started_at": "2012-12-12T10:53:43-08:00",
          "filter_ended_at": "2012-12-12T10:53:43-08:00",
          "release_notes": "Example"
        }
      ]
    }