List pipeline stages

Return stages for one pipeline, sorted by order.

Endpoint

GET
/pipeline-stages

Request

The app sometimes queries by pipeline_id only; including organization_id matches stricter server rules if enabled.

Response

json

Query parameters

ParameterTypeDescription
pipeline_idNumberRequired to list stages for one pipeline.
organization_idNumberOptional filter used in parts of the app.
$sortObjectTypically { "order": 1 }.
$limitNumberAt most 50.
$skipNumberPagination offset.

Multiple pipelines

To load stages for several pipelines (for example after listing conversation pipelines), either call find once per pipeline_id or use an $in query on pipeline_id if your API supports it (the automation configs use $in with pipeline ids from a prior pipelines find).

Report an issue with this documentation

Please log in to report issues with our documentation.