CRM

List Pipelines

Every deal pipeline with its ordered stages. A workspace without one gets the default "Sales" pipeline (Meeting booked, Qualified, Proposal, Negotiation, Won, Lost).

API key access

Needs the crm:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/pipelines
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/pipelines" \  -H "X-Workspace-Id: string"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "position": 0,
      "is_default": true,
      "stages": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",
          "name": "string",
          "position": 0,
          "kind": "open",
          "probability": 0,
          "required_fields": [
            "value"
          ]
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}