Sample - Box Platform API
GET/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention

Get files under retention

Returns a list of files under retention for a retention policy assignment.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
retention_policy_assignment_idstringrequired
The ID of the retention policy assignment.
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`.
limitintegeroptional
The maximum number of items to return per page.

3 status codes
200Returns a list of files under retention that are associated with the specified retention policy assignment.
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<FileMini>optional
A list of files.
400Returns an error if `retention_policy_assignment_id` is not specified.
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.
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

A 400 is returned: Returns an error if retention_policy_assignment_id is not specified. Any other status is an error: An unexpected client error.