GET /legal_hold_policy_assignments

box.com

Summary: List legal hold policy assignments
Operation ID: get_legal_hold_policy_assignments
Auth: unknown
Description

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

Parameters (6)

assign_to_id (string, query, optional)

Filters the results by the ID of item the policy was applied to.

assign_to_type (string, query, optional)

Filters the results by the type of item the policy was applied to.

Constraints: {'enum': ['file', 'file_version', 'folder', 'user']}

fields (array, query, optional)

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.

limit (integer, query, optional)

The maximum number of items to return per page.

Constraints: {'maximum': 1000}

marker (string, query, optional)

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`.

policy_id (string, query, required)

The ID of the legal hold policy

No probe data for this endpoint yet.