Zoho: Pipelines

← Pipeline operations · Get started

Operation zoho.getpipelines

Provider route: GET /crm/v8/settings/pipeline. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["pipeline"]["getPipelines"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.pipeline.getPipelines(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.pipeline.get_pipelines(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.layout_id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Pipelines — response body — pipeline
$ (anyOf 2)	null	Alternative

Referenced models: Pipelines — response body — pipeline

Schemas

Pipelines — response body — pipeline

Field	Type	Presence	Description and constraints
$	object	Root	Root response object containing all pipeline configurations configured for a given Deals layout in Zoho CRM. Additional keys: not allowed
pipeline	array	Required within parent	Array of pipeline configuration items. Maximum items: 90 Minimum items: 1
pipeline[]	Model	Each item	Expand Pipelines — response body — pipeline pipeline item

Referenced models: Pipelines — response body — pipeline pipeline item

Pipelines — response body — pipeline pipeline item

Field	Type	Presence	Description and constraints
$	object	Root	Picklist option representing a pipeline configuration with associated stage mappings. Additional keys: not allowed
actual_value	string	Required within parent	Internal API value for the picklist option. Format: string
default	boolean	Optional	Indicates if this is the default picklist value.
display_value	string	Required within parent	Display name of the picklist value as shown to users. Format: string
id	string	Required within parent	Unique identifier for this picklist value. Format: int64
maps	array	Required within parent	Array of stage mappings for this picklist value. Maximum items: 200 Minimum items: 1
maps[]	Model	Each item	Expand Pipelines — response body — pipeline pipeline item maps item

Referenced models: Pipelines — response body — pipeline pipeline item maps item

Pipelines — response body — pipeline pipeline item maps item

Field	Type	Presence	Description and constraints
$	object	Root	Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details. Additional keys: not allowed
actual_value	string	Required within parent	Internal system value/API name for the stage. Format: string
colour_code	string	Optional	Hexadecimal color code associated with the stage for UI representation. Format: string
display_value	string	Required within parent	User-facing display name of the pipeline stage. Format: string
forecast_category	object	Required within parent	Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting. Additional keys: not allowed
forecast_category.id	string	Required within parent	Unique system identifier for the forecast category. Format: int64
forecast_category.name	string	Required within parent	Represents the name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted'). Format: string
forecast_type	string	Required within parent	Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost'). Format: string
id	string	Required within parent	Unique identifier for this stage mapping. Format: int64
sequence_number	JSON	Required within parent
sequence_number (anyOf 1)	integer	Alternative	Position of this stage in the pipeline sequence (1-based indexing). Format: int32
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: zoho.getpipelines. Catalog operation: getPipelines. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source