> ## 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.

# Zoho CRM: Pipeline Get Pipelines

> List the deal pipelines in a Zoho CRM layout, with their stages. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the deal pipelines in a Zoho CRM layout, with their stages.

> [!NOTE]
>
> Tool ID: `zoho_crm_pipeline_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(
  'zoho_crm_pipeline_get_pipelines',
  {
    "layout_id": "layout_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_pipeline_get_pipelines --input '{
  "layout_id": "layout_123"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_pipeline_get_pipelines --json` for the complete live contract.

## Input reference

Get pipelines for a given layout

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.layout_id` | `string` | Yes | — | Layout Id Format: `int64`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get pipelines for a given layout",
    "properties": {
      "layout_id": {
        "type": "string",
        "description": "Layout Id",
        "format": "int64"
      }
    },
    "required": [
      "layout_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Root response object containing an array of pipeline configurations from Zoho CRM. |
| `result.data.pipeline` | `array` | Yes | — | Array of pipeline configuration items. Minimum items: 1. Maximum items: 90. |
| `result.data.pipeline[].display_value` | `string` | Yes | — | Display name of the picklist value as shown to users. Format: `string`. |
| `result.data.pipeline[].default` | `boolean` | No | — | Indicates if this is the default picklist value. |
| `result.data.pipeline[].maps` | `array` | Yes | — | Array of stage mappings for this picklist value. Minimum items: 1. Maximum items: 200. |
| `result.data.pipeline[].maps[].display_value` | `string` | Yes | — | User-facing display name of the pipeline stage. Format: `string`. |
| `result.data.pipeline[].maps[].sequence_number` | `integer` | Yes | — | Position of this stage in the pipeline sequence (1-based indexing). Format: `int32`. |
| `result.data.pipeline[].maps[].colour_code` | `string` | No | — | Hexadecimal color code associated with the stage for UI representation. Format: `string`. |
| `result.data.pipeline[].maps[].forecast_category` | `object` | Yes | — | Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting. |
| `result.data.pipeline[].maps[].forecast_category.name` | `string` | Yes | — | Human-readable name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted'). Format: `string`. |
| `result.data.pipeline[].maps[].forecast_category.id` | `string` | Yes | — | Unique system identifier for the forecast category. Format: `int64`. |
| `result.data.pipeline[].maps[].actual_value` | `string` | Yes | — | Internal system value/API name for the stage. Format: `string`. |
| `result.data.pipeline[].maps[].id` | `string` | Yes | — | Unique identifier for this stage mapping. Format: `int64`. |
| `result.data.pipeline[].maps[].forecast_type` | `string` | Yes | — | Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost'). Format: `string`. |
| `result.data.pipeline[].actual_value` | `string` | Yes | — | Internal API value for the picklist option. Format: `string`. |
| `result.data.pipeline[].id` | `string` | Yes | — | Unique identifier for this picklist value. Format: `int64`. |
| `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": "Root response object containing an array of pipeline configurations from Zoho CRM.",
        "properties": {
          "pipeline": {
            "type": "array",
            "description": "Array of pipeline configuration items.",
            "minItems": 1,
            "maxItems": 90,
            "items": {
              "type": "object",
              "description": "Picklist option representing a pipeline configuration with associated stage mappings.",
              "properties": {
                "display_value": {
                  "type": "string",
                  "description": "Display name of the picklist value as shown to users.",
                  "format": "string"
                },
                "default": {
                  "type": "boolean",
                  "description": "Indicates if this is the default picklist value."
                },
                "maps": {
                  "type": "array",
                  "description": "Array of stage mappings for this picklist value.",
                  "minItems": 1,
                  "maxItems": 200,
                  "items": {
                    "type": "object",
                    "description": "Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details.",
                    "properties": {
                      "display_value": {
                        "type": "string",
                        "description": "User-facing display name of the pipeline stage.",
                        "format": "string"
                      },
                      "sequence_number": {
                        "type": "integer",
                        "description": "Position of this stage in the pipeline sequence (1-based indexing).",
                        "format": "int32"
                      },
                      "colour_code": {
                        "type": "string",
                        "description": "Hexadecimal color code associated with the stage for UI representation.",
                        "format": "string"
                      },
                      "forecast_category": {
                        "type": "object",
                        "description": "Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting.",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Human-readable name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted').",
                            "format": "string"
                          },
                          "id": {
                            "type": "string",
                            "description": "Unique system identifier for the forecast category.",
                            "format": "int64"
                          }
                        },
                        "required": [
                          "name",
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "actual_value": {
                        "type": "string",
                        "description": "Internal system value/API name for the stage.",
                        "format": "string"
                      },
                      "id": {
                        "type": "string",
                        "description": "Unique identifier for this stage mapping.",
                        "format": "int64"
                      },
                      "forecast_type": {
                        "type": "string",
                        "description": "Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost').",
                        "format": "string"
                      }
                    },
                    "required": [
                      "display_value",
                      "sequence_number",
                      "forecast_category",
                      "actual_value",
                      "id",
                      "forecast_type"
                    ],
                    "additionalProperties": false
                  }
                },
                "actual_value": {
                  "type": "string",
                  "description": "Internal API value for the picklist option.",
                  "format": "string"
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier for this picklist value.",
                  "format": "int64"
                }
              },
              "required": [
                "display_value",
                "maps",
                "actual_value",
                "id"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "pipeline"
        ],
        "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

* [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.