> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive: Get Pipelines

> List the sales pipelines in Pipedrive. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the sales pipelines in Pipedrive.

> [!NOTE]
>
> Tool ID: `pipedrive_get_pipelines`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pipedrive_get_pipelines',
  {
    "sort_by": "id",
    "sort_direction": "asc",
    "limit": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pipedrive_get_pipelines --input '{
  "sort_by": "id",
  "sort_direction": "asc",
  "limit": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "success": true,
    "data": [
      {
        "id": 123,
        "name": "Example",
        "order_nr": 123
      }
    ],
    "additional_data": {
      "next_cursor": "cursor_123"
    }
  }
}
```

Use `deepline describe pipedrive_get_pipelines --json` for the latest machine-readable contract.

## Input reference

Returns data about all pipelines.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.sort_by` | `"id" \| "update_time" \| "add_time"` | No | `"id"` | The field to sort by. Supported fields: `id`, `update_time`, `add_time`. Allowed: `id`, `update_time`, `add_time`. |
| `payload.sort_direction` | `"asc" \| "desc"` | No | `"asc"` | The sorting direction. Supported values: `asc`, `desc`. Allowed: `asc`, `desc`. |
| `payload.limit` | `integer` | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
| `payload.cursor` | `string` | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns data about all pipelines.",
    "properties": {
      "sort_by": {
        "type": "string",
        "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`.",
        "default": "id",
        "enum": [
          "id",
          "update_time",
          "add_time"
        ]
      },
      "sort_direction": {
        "type": "string",
        "description": "The sorting direction. Supported values: `asc`, `desc`.",
        "default": "asc",
        "enum": [
          "asc",
          "desc"
        ]
      },
      "limit": {
        "type": "integer",
        "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
      },
      "cursor": {
        "type": "string",
        "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.success` | `boolean` | No | — | If the response is successful or not |
| `result.data.data` | `array` | No | — | Pipelines array |
| `result.data.data[].id` | `integer` | No | — | The ID of the pipeline |
| `result.data.data[].name` | `string` | No | — | The name of the pipeline |
| `result.data.data[].order_nr` | `integer` | No | — | Defines the order of pipelines. The pipeline with the lowest `order_nr` is considered the default. |
| `result.data.data[].is_deleted` | `boolean` | No | — | Whether this pipeline is marked as deleted or not |
| `result.data.data[].is_deal_probability_enabled` | `boolean` | No | — | Whether deal probability is disabled or enabled for this pipeline |
| `result.data.data[].add_time` | `string` | No | — | The pipeline creation time |
| `result.data.data[].update_time` | `string` | No | — | The pipeline update time |
| `result.data.additional_data` | `object` | No | — | The additional data of the list |
| `result.data.additional_data.next_cursor` | `string` | No | — | The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "If the response is successful or not"
          },
          "data": {
            "type": "array",
            "description": "Pipelines array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the pipeline"
                },
                "name": {
                  "type": "string",
                  "description": "The name of the pipeline"
                },
                "order_nr": {
                  "type": "integer",
                  "description": "Defines the order of pipelines. The pipeline with the lowest `order_nr` is considered the default."
                },
                "is_deleted": {
                  "type": "boolean",
                  "description": "Whether this pipeline is marked as deleted or not"
                },
                "is_deal_probability_enabled": {
                  "type": "boolean",
                  "description": "Whether deal probability is disabled or enabled for this pipeline"
                },
                "add_time": {
                  "type": "string",
                  "description": "The pipeline creation time"
                },
                "update_time": {
                  "type": "string",
                  "description": "The pipeline update time"
                }
              },
              "additionalProperties": false
            }
          },
          "additional_data": {
            "type": "object",
            "description": "The additional data of the list",
            "properties": {
              "next_cursor": {
                "type": "string",
                "description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
              }
            },
            "additionalProperties": false
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Pipedrive provider guide](https://deepline.com/docs/providers/pipedrive/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.