# list

URL: /business/nouns/funnel/list · Id: `verb:Funnel.list` · Call: `await $.Funnel.list({ … })` (SDK) or the `do` tool at `https://api.sb/mcp`. Inputs says what to pass, Outputs what returns, When it waits who approves.

> Returns Funnels, newest first, one page at a time.

List returns [Funnels](/business/nouns/funnel), newest first, one page at a time. It is inherited: every [Noun](/business/nouns/noun) has `get`, `list`, `create`, `update` and `delete`.

## 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. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `funnels` | list of [Funnel](/business/nouns/funnel) | Yes | One page of Funnels. |

## Effects
- Reads only: it emits no Event and changes nothing.
- Read: `try`, `do`.

## 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. | [Funnel.list](/business/nouns/funnel/list) |

## When it waits
Never: a read runs at once.

## Example

**Ask**

```text
Show me my funnel records, newest first.
```

**API**

```bash
curl "https://api.sb/kilnbakery.com/funnels?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/kilnbakery.com",
  "$type": "Funnel",
  "funnels": [
    {
      "$id": "https://api.sb/kilnbakery.com/funnels/funnel_1",
      "$type": "Funnel",
      "steps": {}
    }
  ],
  "meta": {
    "limit": 20,
    "after": "cursor_2"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/funnels?limit=20",
    "next": "https://api.sb/kilnbakery.com/funnels?after=cursor_2"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const funnels = await $.Funnel.list({ limit: 20 })
```

**CLI**

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

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Funnel.list({ limit: 20 })"
  }
}
```