GET
/
funnels
List funnels
curl --request GET \
  --url https://api.funnelfox.io/public/v1/funnels \
  --header 'Fox-Secret: <fox-secret>'
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "alias": "<string>",
      "type": "default",
      "version": 123,
      "environment": "<string>",
      "tags": [
        "<string>"
      ],
      "last_published_at": "2023-11-07T05:31:56Z",
      "status": "draft",
      "experiment": {
        "id": "<string>",
        "title": "<string>",
        "alias": "<string>",
        "enabled": true
      }
    }
  ],
  "pagination": {
    "total": 123,
    "has_more": true
  },
  "next_cursor": "<string>"
}

Headers

Fox-Secret
string
required

Project Secret Key

Example:

"secret_"

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
cursor
string

Cursor for pagination

filter[title]
string

Filter by funnel title (partial match)

filter[alias]
string

Filter by funnel alias (partial match)

filter[deleted]
boolean
default:false

Include deleted funnels

filter[type]
enum<string>

Filter by funnel type

Available options:
default,
cancellation,
retargeting

Response

200
application/json

Funnels list

The response is of type object.