Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Funnel

List Funnels

List Funnels

get/workspaces/{workspace_id}/funnels

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

idstring

A comma-separated list of funnel IDs to filter by.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "id": "1,42"
}
expand[]string[]

Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.

Response

OK

idinteger

Funnel ID

public_idstring

The public identifier of the funnel

workspace_idinteger

The ID of the workspace that the funnel belongs to

namestring

Name of the Funnel

archivedboolean

Archived status

current_pathstring

The URL path of the funnel

live_modeboolean

In Live Mode your Funnel cannot be tested and will process live payments

domain_idinteger nullable

The ID of the domain associated with this funnel. Use the Domains API to look up available domain IDs.

favicon_image_idstring nullable

The ID of the image used as the favicon for this funnel

created_atstring date-time

Created at

updated_atstring date-time

Updated at

head_codestring nullable

Expandable Custom HTML/JavaScript code injected into the funnel head section. Only returned when expand[]=head_code is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

footer_codestring nullable

Expandable Custom HTML/JavaScript code injected before the closing body tag. Only returned when expand[]=footer_code is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

Example response

[
  {
    "id": 1,
    "public_id": "gESyMv",
    "workspace_id": 42000,
    "name": "Example Funnel",
    "archived": false,
    "current_path": "/example-path",
    "live_mode": true,
    "domain_id": 42,
    "favicon_image_id": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "tags": [
      {
        "id": 1,
        "public_id": "JgjGTv",
        "name": "Example Funnel Tag",
        "color": "#00FF00"
      }
    ]
  }
]