---
title: "Teams hooks"
description: "Hand-written shim. Implementation is generated; see ./teams.gen."
section: "Libraries"
group: "React hooks"
order: 456
---

## Hooks

### `useCreateTeam` `mutation`

Create a team.

```ts
useCreateTeam(options?: MutationOpts<Team, CreateTeamParams>)
```

**Types:** [Team](/types/team) · [CreateTeamParams](/types/create-team-params)

### `useDeleteTeam` `mutation`

Soft-delete a team.

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

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

### `useListTeams` `query`

List teams.

```ts
useListTeams(params?: Omit<ListTeamsParams, | > & { filter?: TeamFilter; orderBy?: TeamOrderBy[]; } & TeamShorthands, options?: QueryOpts<Page<Team>>)
```

**Types:** [ListTeamsParams](/types/list-teams-params) · [TeamFilter](/types/team-filter) · [TeamOrderBy](/types/team-order-by) · [TeamShorthands](/types/team-shorthands) · [Page](/types/page) · [Team](/types/team)

### `usePurgeTeam` `composite`

Permanently delete a soft-deleted team.

```ts
usePurgeTeam(options?: MutationOpts<SuccessResponse, PurgeTeamParams>)
```

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

### `useRestoreTeam` `composite`

Restore a soft-deleted team.

```ts
useRestoreTeam(options?: MutationOpts<Team, string>)
```

**Types:** [Team](/types/team)

### `useRetrieveTeam` `query`

Get a team by ID.

```ts
useRetrieveTeam(id: string, options?: QueryOpts<Team>)
```

**Types:** [Team](/types/team)

### `useUpdateTeam` `mutation`

Update a team.

```ts
useUpdateTeam(options?: MutationOpts<Team, UpdateTeamParams>)
```

**Types:** [Team](/types/team) · [UpdateTeamParams](/types/update-team-params)