> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getmodus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# workflows

> Read and run access to Modus workflows.

* [runs](/sdk/typescript/Modus.workflows/classes/runs) — start, monitor, and control workflow runs.
* [workflowActions](/sdk/typescript/Modus.workflows/classes/workflowActions) — execute workflow actions.

## Properties

<ResponseField name={"runs"} type={"WorkflowRunsResource"} required />

<ResponseField name={"workflowActions"} type={"AgentWorkflowActionsResource"} required />

## Methods

### get()

```typescript
get(workflowId: string | number, options?: { view: VariationView; includeVariation: boolean }): Promise<object>
```

Retrieve a workflow by ID or slug.

#### Parameters

<ResponseField name={"workflowId"} type={"string | number"} required>
  Numeric id or slug.
</ResponseField>

<ResponseField name={"options"} type={"{ view: VariationView; includeVariation: boolean }"} />

#### Returns

`Promise<object>`

The workflow.

### list()

```typescript
list(options?: { pageSize: number; pageToken: string; search: string; type: WorkflowType; view: VariationView; includeVariation: boolean }): Promise<Page<object>>
```

List workflows.

#### Parameters

<ResponseField name={"options"} type={"{ pageSize: number; pageToken: string; search: string; type: WorkflowType; view…"} />

#### Returns

`Promise<Page<object>>`

A page of workflows.