List Funnels

List Funnels

Log in to see full request history
Path Params
integer
required
Query Params
string

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

string

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

string

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.

filter
object

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.

Responses

Response body
array of objects
object
integer
required

Funnel ID

string | null

Public Funnel ID

integer | null

The ID of the workspace that the funnel belongs to

string
required

Name of the Funnel

boolean | null

Archived status

string
required

The URL path of the funnel

boolean | null

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

string | null

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

date-time | null

Created at

date-time | null

Updated at

array of objects | null

Funnel Tags

tags
object
integer
required

ID

string | null

Public ID

string
required

The name of the funnel tag

string
required

The color of the funnel tag

Headers
object
string

ID of the last item in the current response after which more records exist. You can use it in an after query parameter for cursor-based pagination to get to the next page.

string

Language
Credentials
URL