---
title: "List funnels"
method: GET
path: "/v1/projects/{projectId}/funnels"
tags: ["Funnels"]
---

# List funnels

`GET /v1/projects/{projectId}/funnels`

## Request

- Base URL: `https://hootlens-api-368877148687.us-east1.run.app`
- URL: `https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/funnels`
- Auth: HTTP bearer

Ordered sequences of goals. A site with goals and no funnels also gets suggestions: starter funnels, each with the settings change that creates it.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

## Path parameters

- `projectId` string, required: An identifier: 1 to 80 letters, digits, underscores or hyphens.

## Response `200`

The funnels.

- object
  - `funnels` Funnel[], required
    - `name` string, required
    - `steps` object[], required
      - `goalId` string, required
    - `id` string, required
    - `createdAt` integer, required
  - `suggestions` FunnelSuggestion[]
    - `name` string, required
    - `basis` 'homepage' | 'visit-order', required
    - `steps` string[], required
    - `reason` string, required
    - `change` object, required: A settings change to pass to the preview route.

## Other responses

- `401`: The credential is missing, expired or revoked.
- `403`: The credential or the person's permissions on the site do not permit this action.
- `404`: The site, or the record inside it, does not exist or the caller is not a member (a non-member cannot tell the two apart).
- `429`: A rate limit or a per-site limit was reached.

---

[API](https://skmtc.dev/hootlens/apis/hoot-lens-api.md) · [All operations](https://skmtc.dev/hootlens/apis/hoot-lens-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hootlens/apis/hoot-lens-api/revisions/f64f8dc7b84e?raw)