--- title: "List a collection's recently deleted items" method: GET path: "/knowledgeBase/{kbId}/trash" tags: ["Knowledge Base"] --- # List a collection's recently deleted items `GET /knowledgeBase/{kbId}/trash` ## Request - Base URL: `https://app.pipeshub.com/api/v1` - URL: `https://app.pipeshub.com/api/v1/knowledgeBase/{kbId}/trash` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `/api/v1/oauth2/authorize` - Client credentials - Token URL: `/api/v1/oauth2/token` scopes: `kb:delete` One page of what was deleted from a collection and can still be restored, newest first. Each item is what one delete removed, as a restore brings it back whole: a folder deleted with its contents is one item, and so is a multi-select delete (`rootCount` items selected, some named in `otherRootNames`). `itemCount` says how many records it holds, the folder included. A folder deleted with `DELETE /knowledgeBase/{kbId}/folder/{folderId}` takes its contents along. A folder deleted with `DELETE /knowledgeBase/record/{recordId}` goes to the trash alone (`itemCount` 1): the records inside it stay live. Restore an item with `POST /knowledgeBase/record/{recordId}/restore`, using its `id`. Needs "Move Deleted Records to the Trash" on in Labs. **Who sees what:** the list holds what the caller may restore. OWNER and WRITER see every item; FILEORGANIZER sees single files only; other roles are refused. The workspace and user always come from the sign-in. **Removed for good:** the scheduled cleanup may remove an item from `removableAfterTimestamp` on (at least 14 days after it was deleted by default; it runs every 14 days, so an item stays 14 to 28 days). It is absent when the retention settings can't be read. An item whose folder is also in the trash (`parentInTrash`) can only be restored after that folder. **Request:** query parameters other than `page` and `limit` are ignored. A page past the last one is answered `200` with no items. ## Path parameters - `kbId` string, required ## Query parameters - `page` integer - `limit` integer ## Response `200` One page of recently deleted items - ListTrashResponseSchema: Response returned by GET /knowledgeBase/{kbId}/trash. - `success` true, required - `items` TrashItemSchema[], required - `id` string, required: Record ID to restore - `name` string, nullable - `recordType` string, nullable - `isFolder` boolean, required: A folder, deleted with everything in it - `mimeType` string, nullable - `sizeInBytes` integer, nullable - `parentId` string, nullable: The folder it was in; null at the collection's top level - `parentName` string, nullable - `parentInTrash` boolean, required: That folder is in the trash too; restore it first - `itemCount` integer, required: Records this delete removed, all of which a restore brings back - `rootCount` integer: Items selected in the delete; more than one for a multi-select delete, which is one item here - `otherRootNames` string[]: Names of up to three of the other items selected with this one - `deletedAtTimestamp` integer, required - `deletedBy` object, nullable - `name` string, nullable - `email` string, nullable - `removableAfterTimestamp` integer, nullable: From when the scheduled cleanup may remove it for good; null when unknown - `pagination` object, required - `page` integer, required - `limit` integer, required - `totalCount` integer, required - `totalPages` integer, required - `retention` object, nullable - `minAgeMs` integer, required: Items stay at least this long before the cleanup may remove them ## Other responses - `400`: page or limit is not a whole number in range, or is sent more than once (`VALIDATION_ERROR` naming `query.page` or `query.limit`, for example "Page must be 1 or more." or "Limit must be between 1 and 100."). Ask for a page from 1 up, with 1 to 100 items per page. Also returned, before authentication, when a query value, or any string in a JSON or form-encoded body, looks like markup to the app-wide XSS filter: an HTML tag, a script tag, `