---
title: "List all legal hold policies"
method: GET
path: "/legal_hold_policies"
tags: ["Legal hold policies"]
---

# List all legal hold policies

`GET /legal_hold_policies`

Retrieves a list of legal hold policies that belong to
an enterprise.

## Query parameters

- `policy_name` string
- `fields` string[]
- `marker` string
- `limit` integer

## Response `200`

Returns a list of legal hold policies.

- LegalHoldPolicies — The part of an API response that describes marker based pagination.
  - `limit` integer — The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
  - `next_marker` string, nullable — The marker for the start of the next page of results.
  - `prev_marker` string, nullable — The marker for the start of the previous page of results.
  - `entries` LegalHoldPolicy[] — A list of legal hold policies.
    - `id` string, required — The unique identifier for this legal hold policy.
    - `type` 'legal_hold_policy', required — The value will always be `legal_hold_policy`.
    - `policy_name` string — Name of the legal hold policy.
    - `description` string — Description of the legal hold policy. Optional property with a 500 character limit.
    - `status` 'active' | 'applying' | 'releasing' | 'released' — 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.
    - `assignment_counts` object — Counts of assignments within a legal hold policy by item type.
      - `user` integer — The number of users this policy is applied to with the `access` type assignment.
      - `folder` integer — The number of folders this policy is applied to.
      - `file` integer — The number of files this policy is applied to.
      - `file_version` integer — The number of file versions this policy is applied to.
      - `ownership` integer — The number of users this policy is applied to with the `ownership` type assignment.
      - `interactions` integer — The number of users this policy is applied to with the `interactions` type assignment.
    - `created_by` object — The user who created the legal hold policy object.
      - `id` string, required — The unique identifier for this user.
      - `type` 'user', required — The value will always be `user`.
      - `name` string — The display name of this user.
      - `login` string, email — The primary email address of this user.
    - `created_at` string, date-time — When the legal hold policy object was created.
    - `modified_at` string, date-time — When the legal hold policy object was modified. Does not update when assignments are added or removed.
    - `deleted_at` string, date-time — 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.
    - `filter_started_at` string, date-time — User-specified, optional date filter applies to Custodian assignments only.
    - `filter_ended_at` string, date-time — User-specified, optional date filter applies to Custodian assignments only.
    - `release_notes` string — Optional notes about why the policy was created.

## Other responses

- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/versions/ba8f087e1a4d/schema)