Stage is a logical component of a pipeline, and essentially a bucket that can hold a number of deals. In the context of the pipeline a stage belongs to, it has an order number which defines the order of stages in that pipeline.
Returns data about all stages.
/api/v2/stages
pipeline_id
integer
The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.
sort_by
string
The field to sort by. Supported fields: id
, update_time
, add_time
, order_nr
.
Default
id
Values
id
update_time
add_time
order_nr
sort_direction
string
The sorting direction. Supported values: asc
, desc
.
Default
asc
Values
asc
desc
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
OK
Returns data about a specific stage.
/api/v2/stages/{id}
id
integer
required
The ID of the stage
OK
Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned.
/v1/stages/{id}/deals
id
integer
required
The ID of the stage
filter_id
integer
If supplied, only deals matching the given filter will be returned
user_id
integer
If supplied, filter_id
will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
everyone
number
If supplied, filter_id
and user_id
will not be considered – instead, deals owned by everyone will be returned
Values
0
1
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
OK
Adds a new stage, returns the ID upon success.
/api/v2/stages
application/json
name
string
required
The name of the stage
pipeline_id
integer
required
The ID of the pipeline to add stage to
deal_probability
integer
The success probability percentage of the deal. Used/shown when deal weighted values are used.
is_deal_rot_enabled
boolean
Whether deals in this stage can become rotten
days_to_rotten
integer
The number of days the deals not updated in this stage would become rotten. Applies only if the is_deal_rot_enabled
is set.
OK
Updates the properties of a stage.
/api/v2/stages/{id}
id
integer
required
The ID of the stage
application/json
name
string
The name of the stage
pipeline_id
integer
The ID of the pipeline to add stage to
deal_probability
integer
The success probability percentage of the deal. Used/shown when deal weighted values are used.
is_deal_rot_enabled
boolean
Whether deals in this stage can become rotten
days_to_rotten
integer
The number of days the deals not updated in this stage would become rotten. Applies only if the is_deal_rot_enabled
is set.
OK
Marks multiple stages as deleted.
/v1/stages
ids
string
required
The comma-separated stage IDs to delete
OK
Marks a stage as deleted.
/api/v2/stages/{id}
id
integer
required
The ID of the stage
OK