Sign in

v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Pipelines

List pipelines

List all pipelines. Optionally filter by book_id to scope to a specific book. Pipeline stages are returned in order and include stage_order, visible, and default_probability.

get/v1/pipelines

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

book_idstring

Filter by book ID

Response

successful

Example response

{
  "data": [
    {
      "id": "pipeline123xyz",
      "name": "Sales Pipeline",
      "pipeline_type": "prospect",
      "book_id": "book123xyz",
      "pipeline_stages": [
        {
          "id": "stage123xyz",
          "name": "Qualified",
          "stage_order": 1,
          "visible": true,
          "default_probability": 50
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}