This API is used to list deals in the CRM with ability to search in it with pagination also.

Method: Get/Post

Base URL :
Mandatory Parameters Sample Description
key 374593457034859 The company account API key, you can get from company settings > API settings
email email for user to authenticate
password 123456 Password for user to authenticate

Optional Parameters for Search/Filter Sample Description
id 876566 the contact id
name new deal name for the deal
description Description Deal Description
won_reasons Deal won_reasons
lost_reason Deal lost_reason
Actual_close_amount Deal Actual_close_amount
external_refernce_id Deal external_refernce_id
custom_field custom_field_api_name any value
screen Return 20 record for each page .Send page number to return page records.(You have total records returned in the response) number of page (required for pagination)



Example :[&name=XXXXX&id=XXXXX&....etc&screen=1]

Response :

  1. {
  2. "message":"success",
  3. "total_records":"20",
  4. "deal_id":"Deal ID",
  5. "contact_id":"Contact ID",
  6. "contact_name":"Firstname Lastname",
  7. "company_id":"Company ID if the contact assigned to a company",
  8. "company_name":"Company Name",
  9. "deal_name":"Deal Name"
  10. "amount":"Deal Amount"
  11. "owner":"Deal Owner Name"
  12. "stage":"Deal stage Name"
  13. "lead_score":"Deal lead_score Name"
  14. "expected_close_date":"Deal Expected Close Date"
  15. "page":"page number"
  16. }
  17. ------OR------
  18. {
  19. "error_message":"error message"
  20. }