List all legal hold policies
GET https://{{api.box.com}}/2.0/legal_hold_policies
Retrieves a list of legal hold policies that belong to
https://developer.box.com/reference/get-legal-hold-policies
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
policy_name | string | Limits results to policies for which the names start with | |
this search term. This is a case-insensitive prefix. | |||
fields | string | A comma-separated list of attributes to include in the | |
response. This can be used to request fields that are | |||
not normally returned in a standard response. |
Be aware that specifying this parameter will have the
effect that none of the standard fields are returned in
the response unless explicitly specified, instead only
fields for the mini representation are returned, additional
to the fields requested. |
| marker
| string | | Defines the position marker at which to begin returning results. This is
used when paginating using marker-based pagination.
This requires usemarker
to be set to true
. |
| limit
| number | | The maximum number of items to return per page. |
RESPONSES
status: OK
{"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","prev_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","entries":[{"id":"11446498","type":"legal_hold_policy","policy_name":"Policy 4","description":"Postman created policy","status":"active","assignment_counts":{"user":1,"folder":2,"file":3,"file_version":4},"created_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"created_at":"2012-12-12T10:53:43-08:00","modified_at":"2012-12-12T10:53:43-08:00","deleted_at":"2012-12-12T10:53:43-08:00","filter_started_at":"2012-12-12T10:53:43-08:00","filter_ended_at":"2012-12-12T10:53:43-08:00","release_notes":"Example"}]}