---
title: "Cleanup Tasks hooks"
description: "Hand-written shim. Generated list+get via ./cleanup-tasks.gen.
useGetCleanupTaskTree + useRetryCleanupTask stay hand-written."
section: "Libraries"
group: "React hooks"
order: 409
---

## Hooks

### `useGetCleanupTaskTree` `query`

```ts
useGetCleanupTaskTree(id: string, options?: QueryOpts<CleanupTask[]>)
```

**Types:** [CleanupTask](/types/cleanup-task)

### `useListCleanupTasks` `query`

List cleanup tasks.

```ts
useListCleanupTasks(params?: Omit<ListCleanupTasksParams, | > & { filter?: CleanupTaskFilter; orderBy?: CleanupTaskOrderBy[]; }, options?: QueryOpts<Page<CleanupTask>>)
```

**Types:** [ListCleanupTasksParams](/types/list-cleanup-tasks-params) · [CleanupTaskFilter](/types/cleanup-task-filter) · [CleanupTaskOrderBy](/types/cleanup-task-order-by) · [Page](/types/page) · [CleanupTask](/types/cleanup-task)

### `useRetrieveCleanupTask` `query`

Get a cleanup task by ID.

```ts
useRetrieveCleanupTask(id: string, options?: QueryOpts<CleanupTask>)
```

**Types:** [CleanupTask](/types/cleanup-task)

### `useRetryCleanupTask` `composite`

```ts
useRetryCleanupTask();
```