Sample - Box Platform API
GET/retention_policies/{retention_policy_id}/assignments

List retention policy assignments

Returns a list of all retention policy assignments associated with a specified retention policy.

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

5 parameters
retention_policy_idstringrequired
The ID of the retention policy.
typestringoptional
The type of the retention policy assignment to retrieve.
Allowed:folderenterprisemetadata_template
fieldsarray<string>optional
A 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.
markerstringoptional
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
limitintegeroptional
The maximum number of items to return per page.

3 status codes
200Returns a list of the retention policy assignments associated with the specified retention policy.
entriesarray<RetentionPolicyAssignment>optional
A list of retention policy assignments.
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.
400Returns an error if an unknown `type` is 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 an unknown type is specified. Any other status is an error: An unexpected client error.