GET retention_policies

box.com

Summary: List retention policies
Operation ID: get_retention_policies
Auth: unknown
Description

Retrieves all of the retention policies for an enterprise.

Parameters (6)

created_by_user_id (string, query, optional)

Filters results by the ID of the user who created policy.

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.

policy_name (string, query, optional)

Filters results by a case sensitive prefix of the name of retention policies.

policy_type (string, query, optional)

Filters results by the type of retention policy.

Constraints: {'enum': ['finite', 'indefinite']}

No probe data for this endpoint yet.