---
title: "Directories hooks"
description: "Hand-written shim. Implementation is generated; see ./directories.gen."
section: "Libraries"
group: "React hooks"
order: 413
---

## Hooks

### `useCreateDirectory` `mutation`

Create a new directory.

```ts
useCreateDirectory(options?: MutationOpts<Directory, CreateDirectoryParams>)
```

**Types:** [Directory](/types/directory) · [CreateDirectoryParams](/types/create-directory-params)

### `useDeleteDirectory` `mutation`

Soft-delete a directory.

```ts
useDeleteDirectory(options?: MutationOpts<SuccessResponse, string>)
```

**Types:** [SuccessResponse](/types/success-response)

### `useListDirectories` `query`

List directories with pagination.

```ts
useListDirectories(params?: Omit<ListDirectoriesParams, | > & { filter?: DirectoryFilter; orderBy?: DirectoryOrderBy[]; } & DirectoryShorthands, options?: QueryOpts<Page<Directory>>)
```

**Types:** [ListDirectoriesParams](/types/list-directories-params) · [DirectoryFilter](/types/directory-filter) · [DirectoryOrderBy](/types/directory-order-by) · [DirectoryShorthands](/types/directory-shorthands) · [Page](/types/page) · [Directory](/types/directory)

### `usePurgeDirectory` `composite`

Permanently delete a soft-deleted directory.

```ts
usePurgeDirectory(options?: MutationOpts<SuccessResponse, PurgeDirectoryParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [PurgeDirectoryParams](/types/purge-directory-params)

### `useRestoreDirectory` `composite`

Restore a soft-deleted directory.

```ts
useRestoreDirectory(options?: MutationOpts<Directory, string>)
```

**Types:** [Directory](/types/directory)

### `useRetrieveDirectory` `query`

Get a single directory by ID.

```ts
useRetrieveDirectory(id: string, options?: QueryOpts<Directory>)
```

**Types:** [Directory](/types/directory)

### `useUpdateDirectory` `mutation`

Update a directory.

```ts
useUpdateDirectory(options?: MutationOpts<Directory, UpdateDirectoryParams>)
```

**Types:** [Directory](/types/directory) · [UpdateDirectoryParams](/types/update-directory-params)