nodestash
Pipelines

Get a pipeline

Retrieves a single pipeline by ID, including all its stages ordered by position. Use the `include` parameter to embed additional data.

GET
/pipelines/{id}

Authorization

apiKey
AuthorizationBearer <token>

API key from your nodestash dashboard. Pass as a Bearer token in the Authorization header.

In: header

Path Parameters

id*string

Pipeline ID (prefixed with pp_).

Match^pp_

Query Parameters

include?string

Related data to include. deal_count adds a deal_count integer to the pipeline attributes and to each stage.

Value in"deal_count"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.nodestash.io/v1/pipelines/pp_8rT4mK9pQsVwXyZaB2cD4"
{
  "data": {
    "id": "pp_8rT4mK9pQsVwXyZaB2cD4",
    "type": "pipeline",
    "attributes": {
      "id": "pp_8rT4mK9pQsVwXyZaB2cD4",
      "name": "Sales Pipeline",
      "description": "Main sales pipeline for inbound leads",
      "is_default": true,
      "stages": [
        {
          "id": "ps_1aB2cD3eF4gH5iJ6kL7m",
          "name": "Qualification",
          "position": 0,
          "type": "open",
          "created_at": "2026-02-01T10:00:00Z",
          "updated_at": "2026-02-01T10:00:00Z"
        },
        {
          "id": "ps_4kT9mN2qRsYvAzCeB2cD4",
          "name": "Negotiation",
          "position": 1,
          "type": "open",
          "created_at": "2026-02-01T10:00:00Z",
          "updated_at": "2026-02-01T10:00:00Z"
        },
        {
          "id": "ps_5dE6fG7hI8jK9lM1nO2p",
          "name": "Closed Won",
          "position": 2,
          "type": "won",
          "created_at": "2026-02-01T10:00:00Z",
          "updated_at": "2026-02-01T10:00:00Z"
        },
        {
          "id": "ps_6eF7gH8iJ9kL1mN2oP3q",
          "name": "Closed Lost",
          "position": 3,
          "type": "lost",
          "created_at": "2026-02-01T10:00:00Z",
          "updated_at": "2026-02-01T10:00:00Z"
        }
      ],
      "created_at": "2026-02-01T10:00:00Z",
      "updated_at": "2026-02-01T10:00:00Z"
    }
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}
{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing or invalid Authorization header"
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Contact not found"
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded"
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}

Delete a pipeline stage

Permanently deletes a stage from a pipeline. Cannot delete the last `won` or `lost` stage — every pipeline must have at least one of each. Cannot delete a stage that still has deals — move deals to another stage first.

List pipelines

Returns a paginated list of pipelines in the authenticated workspace. Each pipeline includes its stages ordered by position.