List file version retentions

GET https://{{api.box.com}}/2.0/file_version_retentions

Retrieves all file version retentions for the given enterprise.

https://developer.box.com/reference/get-file-version-retentions

Request Params

KeyDatatypeRequiredDescription
file_idnumberFilters results by files with this ID.
file_version_idnumberFilters results by file versions with this ID.
policy_idnumberFilters results by the retention policy with this ID.
disposition_actionstringFilters results by the retention policy with this disposition
action.
disposition_beforestringFilters results by files that will have their disposition
come into effect before this date.
disposition_afterstringFilters results by files that will have their disposition
come into effect after this date.
limitnumberThe maximum number of items to return per page.
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. |

RESPONSES

status: OK

{"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","prev_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","entries":[{"id":"11446498","type":"file_version_retention","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"},"file":{"id":"12345","etag":"1","type":"file","sequence_id":"3","name":"Contract.pdf","sha1":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"}},"applied_at":"2012-12-12T10:53:43-08:00","disposition_at":"2012-12-12T10:53:43-08:00","winning_retention_policy":{"id":"12345","type":"retention_policy","policy_name":"Some Policy Name","retention_length":"365","disposition_action":"permanently_delete"}}]}