Skip to main content
API version 2024.0 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.
​
id
string
example: 11446498The unique identifier for this legal hold policy.
​
type
string
example: legal_hold_policyThe value will always be legal_hold_policy.Value is always legal_hold_policy
​
assignment_counts
object
Counts of assignments within this a legal hold policy by item type.
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the legal hold policy object was created.
​
created_by
User (Mini)object
The user who created the legal hold policy object.
​
deleted_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When 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.
​
description
string
example: Postman created policyDescription of the legal hold policy. Optional property with a 500 character limit.
​
filter_ended_at
string(date-time)
example: 2012-12-12T10:53:43-08:00User-specified, optional date filter applies to Custodian assignments only.
​
filter_started_at
string(date-time)
example: 2012-12-12T10:53:43-08:00User-specified, optional date filter applies to Custodian assignments only.
​
modified_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the legal hold policy object was modified. Does not update when assignments are added or removed.
​
policy_name
string
example: Policy 4Name of the legal hold policy.
​
release_notes
string
example: ExampleOptional notes about why the policy was created.
​
status
string
example: activePossible 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
{
  "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": "[email protected]",
    "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"
}