# Flow commands: create, get, list

URL: /code/cli/flow/records · Id: `page:code/cli/flow/records`

> The Flow Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.

Reference for [Flow](/business/nouns/flow), one group of [Flow commands](/code/cli/flow).

### Flow.create
Creates a Flow. [Verb page](/business/nouns/flow/create?interface=cli).

```text
npx startup-builder do Flow.create --json '<input>' [--try | --send | --do]
```

Emits `Flow.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `persona` | [Persona](/business/nouns/persona) | Yes | The Persona it guides; its Role decides which Verbs each step offers. |
| `offer` | [Offer](/business/nouns/offer) | Yes | The Offer whose activation Event ends the Flow; time to value reads from first step to that Event. |
| `steps` | list of [Dashboard](/business/nouns/dashboard) | Yes | The Dashboards in order, first run first, each ending in the Verb that opens the next. |
| `app` | [App](/business/nouns/app) | No | The Flows an App runs on first sign-in, one per Persona and Offer, each ending at the activation Event. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `flow` | [Flow](/business/nouns/flow) | Yes | The Flow. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Flow.create --json '{"persona":"persona_YdpO6wSexq","offer":"offer_2hzYe1ERo0","steps":["dashboard_QL9I0ALqO4"]}'
```

### Flow.get
Returns one Flow by id. [Verb page](/business/nouns/flow/get?interface=cli).

```text
npx startup-builder do Flow.get --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Flow. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `flow` | [Flow](/business/nouns/flow) | Yes | The Flow. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Flow.get --json '{"id":"flow_uuJzIzjvrp"}'
```

### Flow.list
Returns Flows, newest first, one page at a time. [Verb page](/business/nouns/flow/list?interface=cli).

```text
npx startup-builder do Flow.list --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `flows` | list of [Flow](/business/nouns/flow) | Yes | One page of Flows. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Flow.list --json '{"limit":20}'
```