---
title: "Thread Participants hooks"
description: "Hand-written shim. Implementation is generated; see ./thread-participants.gen."
section: "Libraries"
group: "React hooks"
order: 457
---

## Hooks

### `useAddThreadParticipant` `mutation`

Add a participant to a thread.

```ts
useAddThreadParticipant(options?: MutationOpts<ThreadParticipant, AddThreadParticipantParams>)
```

**Types:** [ThreadParticipant](/types/thread-participant) · [AddThreadParticipantParams](/types/add-thread-participant-params)

### `useListThreadParticipants` `query`

List thread participants.

```ts
useListThreadParticipants(params?: Omit<ListThreadParticipantsParams, | > & { filter?: ThreadParticipantFilter; orderBy?: ThreadParticipantOrderBy[]; } & ThreadParticipantShorthands, options?: QueryOpts<Page<ThreadParticipant>>)
```

**Types:** [ListThreadParticipantsParams](/types/list-thread-participants-params) · [ThreadParticipantFilter](/types/thread-participant-filter) · [ThreadParticipantOrderBy](/types/thread-participant-order-by) · [ThreadParticipantShorthands](/types/thread-participant-shorthands) · [Page](/types/page) · [ThreadParticipant](/types/thread-participant)

### `useRemoveThreadParticipant` `mutation`

Remove a thread participant.

```ts
useRemoveThreadParticipant(options?: MutationOpts<SuccessResponse, RemoveThreadParticipantParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [RemoveThreadParticipantParams](/types/remove-thread-participant-params)

### `useRetrieveThreadParticipant` `query`

Get a thread participant by ID.

```ts
useRetrieveThreadParticipant(id: string, options?: QueryOpts<ThreadParticipant>)
```

**Types:** [ThreadParticipant](/types/thread-participant)