---
title: "Schedules hooks"
description: "Hand-written shim. Generated CRUD hooks via ./schedules.gen.
useFireSchedule stays hand-written."
section: "Libraries"
group: "React hooks"
order: 443
---

## Hooks

### `useCreateSchedule` `mutation`

Create a schedule.

```ts
useCreateSchedule(options?: MutationOpts<Schedule, CreateScheduleParams>)
```

**Types:** [Schedule](/types/schedule) · [CreateScheduleParams](/types/create-schedule-params)

### `useDeleteSchedule` `mutation`

Soft-delete a schedule.

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

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

### `useFireSchedule` `composite`

```ts
useFireSchedule(options?: MutationOpts<Schedule, string>)
```

**Types:** [Schedule](/types/schedule)

### `useListSchedules` `query`

List schedules.

```ts
useListSchedules(params?: Omit<ListSchedulesParams, | > & { filter?: ScheduleFilter; orderBy?: ScheduleOrderBy[]; } & ScheduleShorthands, options?: QueryOpts<Page<Schedule>>)
```

**Types:** [ListSchedulesParams](/types/list-schedules-params) · [ScheduleFilter](/types/schedule-filter) · [ScheduleOrderBy](/types/schedule-order-by) · [ScheduleShorthands](/types/schedule-shorthands) · [Page](/types/page) · [Schedule](/types/schedule)

### `usePurgeSchedule` `composite`

Permanently delete a soft-deleted schedule.

```ts
usePurgeSchedule(options?: MutationOpts<SuccessResponse, PurgeScheduleParams>)
```

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

### `useRestoreSchedule` `composite`

Restore a soft-deleted schedule.

```ts
useRestoreSchedule(options?: MutationOpts<Schedule, string>)
```

**Types:** [Schedule](/types/schedule)

### `useRetrieveSchedule` `query`

Get a schedule by ID.

```ts
useRetrieveSchedule(id: string, options?: QueryOpts<Schedule>)
```

**Types:** [Schedule](/types/schedule)

### `useUpdateSchedule` `mutation`

Update a schedule.

```ts
useUpdateSchedule(options?: MutationOpts<Schedule, UpdateScheduleParams>)
```

**Types:** [Schedule](/types/schedule) · [UpdateScheduleParams](/types/update-schedule-params)