List Pipelines
List Pipelines
Path parameters
Query parameters
ID of item after which the collection should be returned. More examples and info about pagination in our guides.
Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.
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 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"
}Response
OK
Example response
[
{
"id": 1,
"public_id": "LbCUlW",
"workspace_id": 42000,
"name": "Example Pipeline",
"created_at": "2025-01-01T00:00:00.000Z",
"updated_at": "2025-01-01T00:00:00.000Z",
"total_value": 0,
"stages": [
{
"id": 35,
"public_id": "LNKqFC",
"workspace_id": 2,
"pipeline_id": 1,
"name": "Example Stage",
"sort_order": 1,
"close_probability": 20,
"opportunity_ids": [
1,
2
],
"total_value": 0,
"weighted_value": 0
},
{
"id": 36,
"public_id": "vhICuX",
"workspace_id": 2,
"pipeline_id": 1,
"name": "Example Stage",
"sort_order": 2,
"close_probability": 20,
"opportunity_ids": [
3,
4
],
"total_value": 0,
"weighted_value": 0
}
]
}
]