Get retention policy

GET https://{{api.box.com}}/2.0/retention_policies/:retention_policy_id

Retrieves a retention policy.

https://developer.box.com/reference/get-retention-policies-id

Request Params

KeyDatatypeRequiredDescription
fieldsstringA 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

{"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}}