Join BoxWorks 2024 to discover what's possible with content and AI!

List previous file versions for legal hold policy assignment

get

https://api.box.com/2.0

/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold

Get a list of previous file versions for a legal hold assignment.

In some cases you may only need the latest file versions instead. In these cases, use the GET /legal_hold_policy_assignments/:id/files_on_hold API instead to return any current (latest) versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all files held for this policy ID. Instead, this API will only return past file versions 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

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Path Parameters

legal_hold_policy_assignment_id stringin pathrequired

example753465

The ID of the legal hold policy assignment

Query Parameters

fields string arrayin queryoptional

exampleid,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.

limit integer (int64)in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

exampleJV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

200application/jsonFile versions on hold

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

defaultapplication/jsonClient error

An unexpected client error.

get

List previous file versions for legal hold policy assignment

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

Response Example

{
  "entries": [
    {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
      "name": "tigers.jpeg",
      "size": 629644,
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "modified_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "trashed_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "restored_at": "2012-12-12T10:53:43-08:00",
      "restored_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "purged_at": "2012-12-12T10:53:43-08:00",
      "uploader_display_name": "Ellis Wiggins"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}