Skip to main content
GET
List Deal Stages
The deal stages configured in this workspace, as an opportunity_stages array of id, name, display_order, probability, is_won, is_closed, forecast_category_cd and type. Takes no parameters. Call it before creating or moving a deal: stage fields expect an id from this list, and probability is what turns a stage into a forecast number.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response

opportunity_stages
string

Opportunity stages list

opportunity_stages[].id
string

Stage ID

opportunity_stages[].team_id
string

Team ID

opportunity_stages[].name
string

Name

opportunity_stages[].display_order
integer

Display order

opportunity_stages[].forecast_category_cd
string

Forecast category code

opportunity_stages[].is_won
boolean

Is won

opportunity_stages[].is_closed
boolean

Is closed

opportunity_stages[].probability
number

Probability

opportunity_stages[].description
string

Description

opportunity_stages[].opportunity_pipeline_id
string

Opportunity pipeline ID

opportunity_stages[].type
string

Type