Box Developer Documentation
Log in

Legal hold policy

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter dates.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
11446498

The unique identifier for this legal hold policy.

string
legal_hold_policy

The value will always be legal_hold_policy.

Value is always legal_hold_policy

object

Counts of assignments within this a legal hold policy by item type.

integer (int64)
3

The number of files this policy is applied to.

integer (int64)
4

The number of file versions this policy is applied to.

integer (int64)
2

The number of folders this policy is applied to.

integer (int64)
1

The number of users this policy is applied to.

string (date-time)
2012-12-12T10:53:43-08:00

When the legal hold policy object was created.

User (Mini) object

The user who created the legal hold policy object.

string (date-time)
2012-12-12T10:53:43-08:00

When the policy release request was sent. (Because it can take time for a policy to fully delete, this isn't quite the same time that the policy is fully deleted).

If null, the policy was not deleted.

string
Postman created policy
500

Description of the legal hold policy. Optional property with a 500 character limit.

string (date-time)
2012-12-12T10:53:43-08:00

User-specified, optional date filter applies to Custodian assignments only.

string (date-time)
2012-12-12T10:53:43-08:00

User-specified, optional date filter applies to Custodian assignments only.

string (date-time)
2012-12-12T10:53:43-08:00

When the legal hold policy object was modified. Does not update when assignments are added or removed.

string
Policy 4
254

Name of the legal hold policy.

string
Example
500

Optional notes about why the policy was created.

string
active

Possible values:

  • 'active' - the policy is not in a transition state.
  • 'applying' - that the policy is in the process of being applied.
  • 'releasing' - that the process is in the process of being released.
  • 'released' - the policy is no longer active.

Value is one of active,applying,releasing,released

Response Example

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