---
title: "Apis hooks"
description: "Hand-written shim. Implementation is generated; see ./apis.gen."
section: "Libraries"
group: "React hooks"
order: 403
---

## Hooks

### `useCreateApi` `mutation`

Create a new API.

```ts
useCreateApi(options?: MutationOpts<Api, CreateApiParams>)
```

**Types:** [Api](/types/api) · [CreateApiParams](/types/create-api-params)

### `useDeleteApi` `mutation`

Soft-delete an API.

```ts
useDeleteApi(options?: MutationOpts<SuccessResponse, DeleteApiParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [DeleteApiParams](/types/delete-api-params)

### `useListApis` `query`

List APIs.

```ts
useListApis(params?: Omit<ListApisParams, | > & { filter?: ApiFilter; orderBy?: ApiOrderBy[]; } & ApiShorthands, options?: QueryOpts<Page<Api>>)
```

**Types:** [ListApisParams](/types/list-apis-params) · [ApiFilter](/types/api-filter) · [ApiOrderBy](/types/api-order-by) · [ApiShorthands](/types/api-shorthands) · [Page](/types/page) · [Api](/types/api)

### `usePurgeApi` `composite`

Permanently delete a soft-deleted API.

```ts
usePurgeApi(options?: MutationOpts<SuccessResponse, PurgeApiParams>)
```

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

### `useRestoreApi` `composite`

Restore a soft-deleted API.

```ts
useRestoreApi(options?: MutationOpts<Api, string>)
```

**Types:** [Api](/types/api)

### `useRetrieveApi` `query`

Get a single API by ID.

```ts
useRetrieveApi(id: string, options?: QueryOpts<Api>)
```

**Types:** [Api](/types/api)

### `useUpdateApi` `mutation`

Update an API.

```ts
useUpdateApi(options?: MutationOpts<Api, UpdateApiParams>)
```

**Types:** [Api](/types/api) · [UpdateApiParams](/types/update-api-params)