List Pipelines

get https://{subdomain}.myclickfunnels.com/api/v2/workspaces/{workspace_id}/sales/pipelines

List Pipelines

Path Params

workspace_id

integer

required

Query Params

after

string

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

sort_order

string

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

sort_property

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

Pipeline ID

public_id

string | null

Pipeline public ID

workspace_id

integer

required

Workspace ID

name

string

required

Pipeline name

created_at

date-time | null

Created at

updated_at

date-time | null

Updated at

total_value

integer | null

Total value of the opportunities

stages

array of objects | null

Stages in the pipeline

stages

object

integer

required

Pipeline ID

public_id

string | null

Pipeline public ID

workspace_id

integer

required

Workspace ID

pipeline_id

integer

Pipeline ID

name

string

required

Pipeline name

sort_order

integer | null

The position of the stage in the pipeline

close_probability

number | null

Close probability of the opportunities in this stage

opportunity_ids

array | null

Opportunities in this stage

opportunity_ids

total_value

integer | null

Total value of the opportunities

weighted_value

number | null

A calculation of the weighted value of all opportunities in this stage

Headers

object

Pagination-Next

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.

Link

string

A direct link to the next page for the cursor-based pagination. It includes the after and the Pagination-Next ID value.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/workspaces/workspace_id/sales/pipelines \
3
     --header 'accept: application/json'


xxxxxxxxxx
84
]
1
[
2
  {
3
    "id": 5,
4
    "public_id": "PZyrEX",
5
    "workspace_id": 42000,
6
    "name": "Example Pipeline",
7
    "created_at": "2025-02-26T12:40:06.020Z",
8
    "updated_at": "2025-02-26T12:40:06.021Z",
9
    "total_value": 0,
10
    "stages": [
11
      {
12
        "id": 19,
13
        "public_id": "XUDPFc",
14
        "workspace_id": 6,
15
        "pipeline_id": 5,
16
        "name": "Example Stage",
17
        "sort_order": 12,
18
        "close_probability": 20,
19
        "opportunity_ids": [
20
          25,
21
          26
22
        ],
23
        "total_value": 0,
24
        "weighted_value": 0
25
      },

200OK

401Unauthorized

404Not Found