List legal hold policy assignments

GET https://{{api.box.com}}/2.0/legal_hold_policy_assignments?policy_id=324432

Retrieves a list of items a legal hold policy has been assigned to.

https://developer.box.com/reference/get-legal-hold-policy-assignments

Request Params

KeyDatatypeRequiredDescription
policy_idnumberThe ID of the legal hold policy
assign_to_typestringFilters the results by the type of item the
policy was applied to.
assign_to_idnumberFilters the results by the ID of item the
policy was applied to.
markerstringDefines 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. | | 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. |

RESPONSES

status: OK

{"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","prev_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","entries":[{"id":"11446498","type":"legal_hold_policy_assignment","legal_hold_policy":{"id":"11446498","type":"legal_hold_policy"},"assigned_to":{"id":"12345","etag":"1","type":"file","sequence_id":"3","name":"Contract.pdf","sha1":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"},"description":"Contract for Q1 renewal","size":629644,"path_collection":{"total_count":1,"entries":[{"id":"12345","etag":"1","type":"folder","sequence_id":"3","name":"Contracts"}]},"created_at":"2012-12-12T10:53:43-08:00","modified_at":"2012-12-12T10:53:43-08:00","trashed_at":"2012-12-12T10:53:43-08:00","purged_at":"2012-12-12T10:53:43-08:00","content_created_at":"2012-12-12T10:53:43-08:00","content_modified_at":"2012-12-12T10:53:43-08:00","created_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"modified_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"owned_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"shared_link":{"url":"https://www.box.com/s/vspke7y05sb214wjokpk","download_url":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","vanity_url":"https://acme.app.box.com/v/my_url/","vanity_name":"my_url","access":"open","effective_access":"company","effective_permission":"can_download","unshared_at":"2018-04-13T13:53:23-07:00","is_password_enabled":true,"permissions":{"can_download":true,"can_preview":true,"can_edit":false},"download_count":3,"preview_count":3},"parent":{"id":"12345","etag":"1","type":"folder","sequence_id":"3","name":"Contracts"},"item_status":"active"},"assigned_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"assigned_at":"2012-12-12T10:53:43-08:00","deleted_at":"2012-12-12T10:53:43-08:00"}]}