List stages with the Zendesk Sell API

Lists the stages of the sales pipelines, with id, name, category (incoming, in_progress, won, lost or unqualified), position, likelihood and pipeline_id, 25 per page by default.

Identifier
zendesk_sell_list_stages

The request

POST https://connect.reportei.com/api/tools/zendesk_sell_list_stages/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "pipeline_id": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
pipeline_idintegerNoId of a pipeline, from the pipeline_id of List stages, to return only its stages.
activebooleanNotrue returns only the stages of open deals, false only the won, lost and unqualified ones.
pageintegerNoPage number, starting at 1.
per_pageintegerNoStages per page, up to 100. The default is 25.

Supported connections

Your customer connects their Zendesk Sell account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/zendesk_sell, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/zendesk_sell_list_stages. It becomes your agent's tool definition with no conversion.

Other Zendesk Sell tools

See all 14 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.