LegalPolicies
Stores legal hold policies created by an enterprise to preserve content for compliance or litigation purposes.
Table Specific Information
Note: The Legal Hold feature must be enabled for a Box enterprise account to query this table. To add this feature, please visit Box Governance and Compliance.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier assigned to the legal hold policy. |
| AssignmentFileCount | Integer | True |
The number of files currently under this legal hold policy. |
| AssignmentFileVersionCount | Integer | True |
The number of file versions assigned to this legal hold policy. |
| AssignmentFolderCount | Integer | True |
The number of folders covered by this legal hold policy. |
| AssignmentUserCount | Integer | True |
The number of users assigned to this legal hold policy. |
| CreatedAt | Datetime | True |
The date and time when the legal hold policy was created. |
| CreatedById | String | True |
Identifier of the user who created the legal hold policy. |
| CreatedByLogin | String | True |
The login email of the user who created the legal hold policy. |
| CreatedByName | String | True |
The full name of the user who created the legal hold policy. |
| CreatedByType | String | True |
Specifies the type of user or account that created the policy, such as a user or service account. |
| DeletedAt | Datetime | True |
The date and time when the legal hold policy was deleted, if applicable. |
| Description | String | False |
A user-provided description of the legal hold policy and its intended purpose. |
| FilterEndedAt | Datetime | False |
The end date and time of the policy's filter criteria, used to define the retention window. |
| FilterStartedAt | Datetime | False |
The start date and time of the policy's filter criteria, used to define the retention window. |
| ModifiedAt | Datetime | True |
The date and time when the legal hold policy was last updated. |
| PolicyName | String | False |
The display name of the legal hold policy. |
| ReleaseNotes | String | False |
Notes provided when the policy was released, describing the reason or details of the release. |
| Status | String | True |
The current state of the policy, such as active or released. |
| Type | String | True |
Specifies the type of policy, such as legal hold or another retention category. |
| AsUserId | String | False |
Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts. |
| IsOngoing | Boolean | False |
Indicates whether the policy should continue applying to new assignments created after its initialization. |