Sample - Box Platform API
GET/file_version_retentions/{file_version_retention_id}

Get retention on file

Returns information about a file version retention.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

1 parameter
file_version_retention_idstringrequired
The ID of the file version retention.

2 status codes
200Returns a file version retention object.
idstringoptional
The unique identifier for this file version retention.
typestringoptional
The value will always be `file_version_retention`.
Allowed:file_version_retention
file_versionobjectoptional
fileobjectoptional
applied_atstringoptional
When this file version retention object was created.
disposition_atstringoptional
When the retention expires on this file version retention.
winning_retention_policyobjectoptional
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.