Skip to main content
GET
List the stages of an opportunity type in the caller's tenant.

Authorizations

x-api-key
string
header
required

Path Parameters

type_uuid
string
required

Query Parameters

stage_type
enum<string>
default:PARENT

Which stage set to return: 'PARENT' for top-level opportunity stages, 'CHILD' for sub-opportunity stages. Defaults to 'PARENT'.

Available options:
PARENT,
CHILD
show_hidden
boolean
default:false

Include stages hidden from the UI. Defaults to false so only user-selectable stages are returned.

Response

200 - application/json

List of stages for an opportunity type.

items
OpportunityStageListItem · object[]
required
total
integer
required