---
title: "List funnels"
method: POST
path: "/funnels/list"
tags: ["Funnels"]
---

# List funnels

`POST /funnels/list`

## Request

- Base URL: `https://api.databuddy.cc`
- URL: `https://api.databuddy.cc/funnels/list`
- Auth: API key in header `x-api-key`

Returns all funnels for a website. Requires website read permission.

## Request body

- object
  - `websiteId` string, required

## Response `200`

OK

- object[]
  - `createdAt` string, date-time, required
  - `description` string, nullable, required
  - `filters` object[], nullable, required
    - `field` string, required
    - `operator` 'contains' | 'ends_with' | 'equals' | 'in' | 'not_contains' | 'not_equals' | 'not_in' | 'starts_with', required
    - `value` union, required
      - string
      - string[]
  - `id` string, required
  - `ignoreHistoricData` boolean, required
  - `isActive` boolean, required
  - `name` string, required
  - `steps` object[], required
    - `type` 'PAGE_VIEW' | 'EVENT' | 'CUSTOM', required
    - `target` string, required
    - `name` string, required
    - `conditions` object
  - `updatedAt` string, date-time, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `403`: 403
- `404`: 404
- `409`: 409
- `429`: 429
- `500`: 500
- `503`: 503

---

[API](https://skmtc.dev/databuddy/apis/databuddy-api.md) - [All operations](https://skmtc.dev/databuddy/apis/databuddy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/databuddy/apis/databuddy-api/revisions/ddfbba648d52?raw)
