Box Developer Documentation
Log in

List files with current file versions for legal hold policy assignment

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

Get a list of files with current file versions for a legal hold assignment.

In some cases you may want to get previous file versions instead. In these cases, use the GET /legal_hold_policy_assignments/:id/file_versions_on_hold API instead to return any previous versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The GET /file_version_legal_holds API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
753465

The ID of the legal hold policy assignment

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 (int64)in 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.

Response

application/jsonFiles on hold

Returns the list of current file versions held under legal hold for a specific legal hold policy assignment.

application/jsonClient error

An unexpected client error.

get
List files with current file versions for legal hold policy assignment
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentFileOnHold(
  legalHoldPolicyAssignmentId,
);
Python Gen
client.legal_hold_policy_assignments.get_legal_hold_policy_assignment_file_on_hold(
    legal_hold_policy_assignment_id
)
.NET Gen
await client.LegalHoldPolicyAssignments.GetLegalHoldPolicyAssignmentFileOnHoldAsync(legalHoldPolicyAssignmentId: legalHoldPolicyAssignmentId);
Swift Gen (Beta)
try await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentFileOnHold(legalHoldPolicyAssignmentId: legalHoldPolicyAssignmentId)

Response Example

{
  "entries": [
    {
      "id": "12345",
      "etag": "1",
      "type": "file",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}