---
title: "Workspace Members hooks"
description: "Hand-written shim. Implementation is generated; see ./workspace-members.gen."
section: "Libraries"
group: "React hooks"
order: 475
---

## Hooks

### `useAddWorkspaceMember` `mutation`

Add a member to a workspace.

```ts
useAddWorkspaceMember(options?: MutationOpts<WorkspaceMember, AddWorkspaceMemberParams>)
```

**Types:** [WorkspaceMember](/types/workspace-member) · [AddWorkspaceMemberParams](/types/add-workspace-member-params)

### `useListWorkspaceMembers` `query`

List workspace members.

```ts
useListWorkspaceMembers(params?: Omit<ListWorkspaceMembersParams, | > & { filter?: WorkspaceMemberFilter; orderBy?: WorkspaceMemberOrderBy[]; } & WorkspaceMemberShorthands, options?: QueryOpts<Page<WorkspaceMember>>)
```

**Types:** [ListWorkspaceMembersParams](/types/list-workspace-members-params) · [WorkspaceMemberFilter](/types/workspace-member-filter) · [WorkspaceMemberOrderBy](/types/workspace-member-order-by) · [WorkspaceMemberShorthands](/types/workspace-member-shorthands) · [Page](/types/page) · [WorkspaceMember](/types/workspace-member)

### `useRemoveWorkspaceMember` `mutation`

Remove a workspace member.

```ts
useRemoveWorkspaceMember(options?: MutationOpts<SuccessResponse, RemoveWorkspaceMemberParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [RemoveWorkspaceMemberParams](/types/remove-workspace-member-params)

### `useRetrieveWorkspaceMember` `query`

Get a workspace member by ID.

```ts
useRetrieveWorkspaceMember(id: string, options?: QueryOpts<WorkspaceMember>)
```

**Types:** [WorkspaceMember](/types/workspace-member)

### `useUpdateWorkspaceMember` `mutation`

Update a workspace member.

```ts
useUpdateWorkspaceMember(options?: MutationOpts<WorkspaceMember, UpdateWorkspaceMemberParams>)
```

**Types:** [WorkspaceMember](/types/workspace-member) · [UpdateWorkspaceMemberParams](/types/update-workspace-member-params)