---
title: "Get workspaces workspaceID retention"
method: GET
path: "/v1/workspaces/{workspaceID}/retention"
---

# Get workspaces workspaceID retention

`GET /v1/workspaces/{workspaceID}/retention`

## Request

- Base URL: `https://api.plori.ai`
- URL: `https://api.plori.ai/v1/workspaces/{workspaceID}/retention`
- Auth: HTTP bearer

Candidate Workspace API. Access depends on the owner cohort and, for Files routes, the Files gate. Check operation state and retained data before assuming a write is durable.

## Path parameters

- `workspaceID` string, uuid, required

## Query parameters

- `view` 'cleanup' | 'pins'
- `cursor` string, uuid
- `limit` integer

## Response `200`

Request accepted or completed.

- WorkspaceRetentionView
  - `policy` object, required
  - `storage_limits` object, nullable, required
  - `pins` WorkspaceRetentionPin[], required
    - `id` string, uuid, required
    - `owner_user_id` string, uuid
    - `resource_kind` string, required
    - `resource_id` string, uuid, required
    - `created_at` string, date-time
    - `expires_at` string, date-time, required
    - `released_at` string, date-time
  - `cleanup` object[], required
  - `next_cursor` string
  - `view` 'cleanup' | 'pins', required
  - `counts` object, required

## Other responses

- `400`: Malformed request.
- `401`: Missing or invalid credential.
- `404`: No such resource.
- `409`: A deleting Workspace returns code workspace_deleting.

---

[API](https://skmtc.dev/plori/apis/plori-rest-api.md) · [All operations](https://skmtc.dev/plori/apis/plori-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/plori/apis/plori-rest-api/revisions/2234a20f0150?raw)