---
title: "client.workflows"
description: ""
section: "Libraries"
group: "SDK resources"
order: 207
---

Accessed via `client.workflows`.

## Methods

### `create`

Create a workflow.

```ts
create(params: CreateWorkflowParams): Promise<Workflow>
```

**Types:** [CreateWorkflowParams](/types/create-workflow-params) · [Workflow](/types/workflow)

### `delete`

Soft-delete a workflow.

```ts
delete(params: DeleteWorkflowParams): Promise<SuccessResponse>
```

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

### `list`

List workflows.

```ts
list(params?: Omit<ListWorkflowsParams, "filter" | "orderBy"> & { filter?: WorkflowFilter; orderBy?: WorkflowOrderBy[]; } & WorkflowShorthands): Promise<Page<Workflow>>
```

**Types:** [ListWorkflowsParams](/types/list-workflows-params) · [WorkflowFilter](/types/workflow-filter) · [WorkflowOrderBy](/types/workflow-order-by) · [WorkflowShorthands](/types/workflow-shorthands) · [Page](/types/page) · [Workflow](/types/workflow)

### `purge`

Permanently delete a soft-deleted workflow.

```ts
purge(params: PurgeWorkflowParams): Promise<SuccessResponse>
```

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

### `restore`

Restore a soft-deleted workflow.

```ts
restore(params: RestoreWorkflowParams): Promise<Workflow>
```

**Types:** [RestoreWorkflowParams](/types/restore-workflow-params) · [Workflow](/types/workflow)

### `retrieve`

Get a workflow by ID.

```ts
retrieve(params: RetrieveWorkflowParams): Promise<Workflow>
```

**Types:** [RetrieveWorkflowParams](/types/retrieve-workflow-params) · [Workflow](/types/workflow)

### `update`

Update a workflow.

```ts
update(params: UpdateWorkflowParams): Promise<Workflow>
```

**Types:** [UpdateWorkflowParams](/types/update-workflow-params) · [Workflow](/types/workflow)

## client.workflows.runs

Sub-resource for retrieving the hydrated workflow-run projection.

Accessed via `client.workflows.runs`.

### `get`

Get a specific workflow run with hydrated children + nodes + edges.
`GET /api/workflows/:id/runs/:runId`

```ts
get(params: GetWorkflowRunParams): Promise<WorkflowRun>
```

**Types:** [GetWorkflowRunParams](/types/get-workflow-run-params) · [WorkflowRun](/types/workflow-run)