Box Developer Documentation

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Retention policy (Base)

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

A base representation of a retention policy.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

string
12345

The unique identifier that represents a retention policy.

string
retention_policy

The value will always be retention_policy.

Value is always retention_policy

Response Example

{
  "id": "12345",
  "type": "retention_policy"
}