🚧
Opportunity stages are only available in the pro plan and require the pipeline feature to be turned on in your workspace.

Example

{
  "id": "0fed94b3-c5f7-40a4-9bd6-9d15c45f739d",
  "name": "Closed Won",
  "description": "The opportunity has been successfully closed and converted into a customer.",
  "probability": 1,
  "statusId": "won",
  "isActive": true,
  "createdAt": "2024-07-26T22:05:08.668Z"
}

Attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the opportunity stage.
`description`	`string`	The description of the opportunity stage.
`probability`	`number`	Percentage chance of the opportunity progressing to a successful conclusion.
`statusId`	`string`	Unique identifier for the current state of the opportunity. Can be one of `open`, `won` or `lost`.
`isActive`	`boolean`	A flag to indicate if the opportunity stage is active in the system.
`createdAt`	`timestamp`	The timestamp when the object was created.