List retention policies
GET https://{{api.box.com}}/2.0/retention_policies
Retrieves all of the retention policies for an enterprise.
https://developer.box.com/reference/get-retention-policies
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
policy_name | string | Filters results by a case sensitive prefix of the name of | |
| retention policies. | |||
policy_type | string | Filters results by the type of retention policy. | |
created_by_user_id | number | Filters results by the ID of the user who created policy. | |
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. |
| limit | number | | The maximum number of items to return per page. |
| marker | string | | Defines the position marker at which to begin returning results. This is
used when paginating using marker-based pagination. |
RESPONSES
status: OK
{"entries":[{"id":"12345","type":"retention_policy","policy_name":"Some Policy Name","retention_length":"365","disposition_action":"permanently_delete","description":"Policy to retain all reports for at least one month","policy_type":"finite","retention_type":"non_modifiable","status":"active","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","can_owner_extend_retention":false,"are_owners_notified":false,"custom_notification_recipients":[{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"}],"assignment_counts":{"enterprise":1,"folder":1,"metadata_template":1}}],"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}