Funnel

Private Funnel API endpoints

Endpoints

GET/funnels
GET/funnels/{funnel_id}

Get list of funnels

GET /funnels

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

queryoptionalstring

Search query

ReturnsFunnel[]

Funnels list response

curl https://api.subbly.co/private/v1/funnels \
  -H 'X-API-KEY: <api-key>'

Response

[
  {
    "id": 1,
    "name": "name",
    "weight": 1,
    "published": true,
    "steps": [
      {
        "id": 1,
        "type": "funnel_pre_purchase",
        "initial": true,
        "addon": true,
        "addon_duration": 1,
        "external_url": "external_url",
        "next_step_id": 1,
        "reject_next_step_id": 1,
        "payload": {
          "id": 1,
          "title": "title",
          "description": "description",
          "type": "one_click",
          "amount_off": 1,
          "percent_off": 1.5,
          "skip_answered_survey": true,
          "product_ids": [
            1
          ]
        },
        "created_at": "2026-01-15T10:30:00Z",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z"
  }
]

Get funnel by ID

GET /funnels/{funnel_id}

Path parameters

funnel_idRequiredinteger

Funnel ID

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

ReturnsFunnel

Funnel object response

curl https://api.subbly.co/private/v1/funnels/{funnel_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "name",
  "weight": 1,
  "published": true,
  "steps": [
    {
      "id": 1,
      "type": "funnel_pre_purchase",
      "initial": true,
      "addon": true,
      "addon_duration": 1,
      "external_url": "external_url",
      "next_step_id": 1,
      "reject_next_step_id": 1,
      "payload": {
        "id": 1,
        "title": "title",
        "description": "description",
        "type": "one_click",
        "amount_off": 1,
        "percent_off": 1.5,
        "skip_answered_survey": true,
        "product_ids": [
          1
        ]
      },
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Funnel

Private Funnel API endpoints

Endpoints

GET/funnels
GET/funnels/{funnel_id}

Get list of funnels

GET /funnels

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

queryoptionalstring

Search query

ReturnsFunnel[]

Funnels list response

idinteger

namestring | null

weightinteger

publishedboolean

stepsFunnelStep[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/private/v1/funnels \
  -H 'X-API-KEY: <api-key>'

Response

[
  {
    "id": 1,
    "name": "name",
    "weight": 1,
    "published": true,
    "steps": [
      {
        "id": 1,
        "type": "funnel_pre_purchase",
        "initial": true,
        "addon": true,
        "addon_duration": 1,
        "external_url": "external_url",
        "next_step_id": 1,
        "reject_next_step_id": 1,
        "payload": {
          "id": 1,
          "title": "title",
          "description": "description",
          "type": "one_click",
          "amount_off": 1,
          "percent_off": 1.5,
          "skip_answered_survey": true,
          "product_ids": [
            1
          ]
        },
        "created_at": "2026-01-15T10:30:00Z",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z"
  }
]

Get funnel by ID

GET /funnels/{funnel_id}

Path parameters

funnel_idRequiredinteger

Funnel ID

Query parameters

expand[]optionalstring[]

List of relations to expand in the response.

ReturnsFunnel

Funnel object response

idinteger

namestring | null

weightinteger

publishedboolean

stepsFunnelStep[] | null

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/private/v1/funnels/{funnel_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "name",
  "weight": 1,
  "published": true,
  "steps": [
    {
      "id": 1,
      "type": "funnel_pre_purchase",
      "initial": true,
      "addon": true,
      "addon_duration": 1,
      "external_url": "external_url",
      "next_step_id": 1,
      "reject_next_step_id": 1,
      "payload": {
        "id": 1,
        "title": "title",
        "description": "description",
        "type": "one_click",
        "amount_off": 1,
        "percent_off": 1.5,
        "skip_answered_survey": true,
        "product_ids": [
          1
        ]
      },
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}