> ## 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 Stages > Get all stages. Pipedrive Get Stages reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost. Get all stages. Tool ID: `pipedrive_get_stages` ## Run this action Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV. ```ts theme={null} import { Deepline } from 'deepline'; const deepline = await Deepline.connect(); const result = await deepline.tools.execute( 'pipedrive_get_stages', { "pipeline_id": 123, "sort_by": "id", "sort_direction": "asc" }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={null} deepline tools execute pipedrive_get_stages --input '{ "pipeline_id": 123, "sort_by": "id", "sort_direction": "asc" }' --json ``` ## Example response The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative. ```json theme={null} { "data": { "success": true, "data": [ { "id": 123, "order_nr": 123, "name": "Example" } ], "additional_data": { "next_cursor": "cursor_123" } } } ``` Use `deepline tools get pipedrive_get_stages --json` for the latest machine-readable contract. ## Input reference Returns data about all stages. | Name | Type | Required | Default | Details | | ------------------------ | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `payload.pipeline_id` | `integer` | No | — | The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. | | `payload.sort_by` | `"id" \| "update_time" \| "add_time" \| "order_nr"` | No | `"id"` | The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `order_nr`. Allowed: `id`, `update_time`, `add_time`, `order_nr`. | | `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 |
Show raw input schema ### Input JSON Schema ```json theme={null} { "type": "object", "description": "Returns data about all stages.", "properties": { "pipeline_id": { "type": "integer", "description": "The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched." }, "sort_by": { "type": "string", "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `order_nr`.", "default": "id", "enum": [ "id", "update_time", "add_time", "order_nr" ] }, "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 } ```
## 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 | — | The array of stages | | `result.data.data[].id` | `integer` | No | — | The ID of the stage | | `result.data.data[].order_nr` | `integer` | No | — | Defines the order of the stage | | `result.data.data[].name` | `string` | No | — | The name of the stage | | `result.data.data[].is_deleted` | `boolean` | No | — | Whether the stage is marked as deleted or not | | `result.data.data[].deal_probability` | `integer` | No | — | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | | `result.data.data[].pipeline_id` | `integer` | No | — | The ID of the pipeline to add the stage to | | `result.data.data[].is_deal_rot_enabled` | `boolean` | No | — | Whether deals in this stage can become rotten | | `result.data.data[].days_to_rotten` | `integer \| null` | No | — | The number of days the deals not updated in this stage would become rotten. Applies only if the `is_deal_rot_enabled` is set. | | `result.data.data[].add_time` | `string` | No | — | The stage creation time | | `result.data.data[].update_time` | `string` | No | — | The stage 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). |
Show raw output schema ### Output JSON Schema ```json theme={null} { "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": "The array of stages", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the stage" }, "order_nr": { "type": "integer", "description": "Defines the order of the stage" }, "name": { "type": "string", "description": "The name of the stage" }, "is_deleted": { "type": "boolean", "description": "Whether the stage is marked as deleted or not" }, "deal_probability": { "type": "integer", "description": "The success probability percentage of the deal. Used/shown when the deal weighted values are used." }, "pipeline_id": { "type": "integer", "description": "The ID of the pipeline to add the stage to" }, "is_deal_rot_enabled": { "type": "boolean", "description": "Whether deals in this stage can become rotten" }, "days_to_rotten": { "type": [ "integer", "null" ], "description": "The number of days the deals not updated in this stage would become rotten. Applies only if the `is_deal_rot_enabled` is set." }, "add_time": { "type": "string", "description": "The stage creation time" }, "update_time": { "type": "string", "description": "The stage 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 } }, "additionalProperties": false }, "meta": { "type": "object", "description": "Additional response metadata (status, paging).", "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": false } ```
## 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](/docs/providers/pipedrive/guide) * [SDK V2 quickstart](/docs/sdk-v2/quickstart) * [SDK reference](/docs/sdk-v2/sdk-reference) * [Run tools across a CSV](/docs/sdk-v2/batch-csv)