Get Funnels

GET 
/funnels/funnel

Returns the funnels for a location. v4 successor to GET /funnels/funnel/list.

Request

Version stringrequired

API Version

Available optionsv4

locationId stringrequired

Identifier of the location

type string

Filter by funnel type

category string

Filter by category

parentId string

Identifier of the parent folder

name string

Case-insensitive substring filter by funnel name

limit number

Maximum number of funnels to return

Possible values: >= 1 and <= 100

Default value:100

skip number

Number of funnels to skip

Possible values: >= 0

Default value:0

query string

Free-text search over funnel names. Takes precedence over name when both are provided; an empty value is ignored and name still applies.

application/json

Successful response

application/json

Schema

Schema

funnelsobject[]required

The funnels matching the query, sorted by category and last update

countnumberrequired

Total number of funnels matching the query, ignoring limit and offset

Example (auto)

{
  "funnels": [
    {
      "_id": "6058faaf6abc1100270a14e9",
      "name": "Lead Magnet Funnel",
      "locationId": "6p2RxpgtMKQwO3E6IUaT",
      "type": "funnel"
    }
  ],
  "count": 10
}