GET /deals/summary

Returns a summary of all not archived deals.

Servers

Query parameters

Name Type Required Description
filter_id Integer No

user_id will not be considered. Only deals matching the given filter will be returned.

status String No

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

Possible values:

  • "open"
  • "lost"
  • "won"
stage_id Integer No

Only deals within the given stage will be returned

pipeline_id Integer No

Only deals within the given pipeline will be returned

user_id Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.