Sample - Box Platform API
GET/file_version_retentions

List file version retentions

Retrieves all file version retentions for the given enterprise.

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.

8 parameters
file_idstringoptional
Filters results by files with this ID.
file_version_idstringoptional
Filters results by file versions with this ID.
policy_idstringoptional
Filters results by the retention policy with this ID.
disposition_actionstringoptional
Filters results by the retention policy with this disposition action.
Allowed:permanently_deleteremove_retention
disposition_beforestringoptional
Filters results by files that will have their disposition come into effect before this date.
disposition_afterstringoptional
Filters results by files that will have their disposition come into effect after this date.
limitintegeroptional
The maximum number of items to return per page.
markerstringoptional
Defines 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`.

2 status codes
200Returns a list of all file version retentions for the enterprise.
limitintegeroptional
The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
next_markerstringoptional
The marker for the start of the next page of results.
prev_markerstringoptional
The marker for the start of the previous page of results.
entriesarray<FileVersionRetention>optional
A list of file version retentions.
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.