v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Retention policies

List retention policies

Retrieves all of the retention policies for an enterprise.

get/retention_policies

Query parameters

policy_namestring

Filters results by a case sensitive prefix of the name of retention policies.

policy_type'finite' | 'indefinite'

Filters results by the type of retention policy.

created_by_user_idstring

Filters results by the ID of the user who created policy.

fieldsstring[]

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.

limitinteger

The maximum number of items to return per page.

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

Response

Returns a list retention policies in the enterprise.

limitinteger

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_markerstring nullable

The marker for the start of the next page of results.

Example response

{
  "entries": [
    {
      "id": "12345",
      "type": "retention_policy",
      "policy_name": "Some Policy Name",
      "retention_length": "365",
      "disposition_action": "permanently_delete",
      "description": "Policy to retain all reports for at least one month",
      "policy_type": "finite",
      "retention_type": "non_modifiable",
      "status": "active",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "custom_notification_recipients": [
        {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        }
      ],
      "assignment_counts": {
        "enterprise": 1,
        "folder": 1,
        "metadata_template": 1
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}