v1

latestOpenAPI 3.0.12026-08-0621301.7 MB
Deals

Get archived deals summary

Returns a summary of all archived deals.

get/deals/summary/archived

Query parameters

status'open' | 'won' | 'lost'

Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.

filter_idinteger

<code>user_id</code> will not be considered. Only deals matching the given filter will be returned.

user_idinteger

Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.

pipeline_idinteger

Only deals within the given pipeline will be returned

stage_idinteger

Only deals within the given stage will be returned

Response

Get the summary of archived deals

successboolean

If the response is successful or not