Skip to main content
GET
/
file_version_legal_holds
/
{file_version_legal_hold_id}
cURL
curl -i -X GET "https://api.box.com/2.0/file_version_legal_holds/2348213" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "id": "11446498",
  "type": "file_version_legal_hold",
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "file": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "legal_hold_policy_assignments": [
    {
      "id": "11446498",
      "type": "legal_hold_policy_assignment",
      "legal_hold_policy": {
        "id": "11446498",
        "type": "legal_hold_policy"
      },
      "assigned_to": {
        "type": "folder",
        "id": "6564564"
      },
      "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"
    }
  ],
  "deleted_at": "2012-12-12T10:53:43-08:00"
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_version_legal_hold_id
string
required

The ID of the file version legal hold.

Response

Returns the legal hold policy assignments for the file version.

File version legal hold is an entity representing all holds on a File Version.

​
id
string

The unique identifier for this file version legal hold.

Example:

"11446498"

​
type
enum<string>

The value will always be file_version_legal_hold.

Available options:
file_version_legal_hold
Example:

"file_version_legal_hold"

​
file_version
File version (Mini) · object

The file version that is held.

​
file
File (Mini) · object

The file for the file version held. Note that there is no guarantee that the current version of this file is held.

​
legal_hold_policy_assignments
Legal hold policy assignment · object[]

List of assignments contributing to this Hold.

​
deleted_at
string<date-time>

Time that this File-Version-Legal-Hold was deleted.

Example:

"2012-12-12T10:53:43-08:00"