Zoho CRM: Pipeline Get Pipelines

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

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.

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

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

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

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation