# workflows list

## Synopsis

```shell
omics workbench workflows list
  [--max-results=NUMBER]
  [--page=NUMBER]
  [--page-size=NUMBER]
  [--order=ORDER_STRING]
  [--search=TEXT]
  [--source=WORKFLOWSOURCE]
  [--include-deleted]
```

## Description

List all the workflows matching the given filters, fetching each page of data sequentially and printing it to the console.

## Examples

List all the workflows without applying any filters.

```shell
omics workbench workflows list
```

You can refine your search and only include `PRIVATE` workflows

```shell
omics workbench workflows list --source PRIVATE
```

Or perform whole text searches across multiple fields.

```shell
omics workbench workflows list --search "My Workflow"
```

## Flags:

### `--max-results`=`NUMBER`

Limit the maximum number of results printed to the console.

### `--page`=`NUMBER`

Used to set the offset page number. This allows for jumping into an arbitrary page of results.

### `--page-size`=`NUMBER`

Used to set the number of results returned per page (default 100). Reducing the page size can help with poor internet connections.

### `--sort`=`SORT_STRING`

Used to sort the runs ordered by a set of given properties and directions. The `SORT_STRING` consists of multiple properties you would like to order by, in the form `column(:direction)?(;(column(:direction)?)*`. The direction of the ordering is optional and if it is omitted the default ordering is ascending.

Valid Directions: `ASC`, `DESC` Valid Columns: `run_id`, `start_time`, `end_time`, `state`, `workflow_name`, `submitted_by`, `engine_id`

Examples: `run_id:ASC;start_time:DESC`, `state;workflow_name:DESC`

### `--order`=`ORDER_STRING`

**Note**: This flag is now deprecated - please use `--sort` instead. Return the runs ordered by the given property. The `ORDER_STRING` consists of the property you would like to order by, optionally followed by the direction of the ordering. If the direction is omitted it is assumed to be in descending order.

Valid Directions: `ASC`, `DESC`\
Valid Properties: `name`, `source`, `organization`, `last_updated_at`

Examples: `run_id ASC`, `start_time DESC`

### `--search`=`TEXT`

Perform a full-text search across various fields in a case-insensitive way, returning runs where the given search string was contained in the text of the field. Properties which support full-text searching include: `id`, `internal_id`, `name`, `latestVersion`, `latestVersionName`, `organization`.

### `--source`=`WORKFLOWSOURCE`

Return the workflows that are from the given source.

Valid sources: `DOCKSTORE`, `PRIVATE`

### `--include-deleted`

When a workflow is deleted from workbench it is no longer usable in a new run, however a reference to it is kept for provenance. By default, deleted workflows are not included in the list operations. Specifying the `--list-deleted` flag will include the deleted workflows in the response