This API is used to list companies 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 company id
company_email email for the company
dba Hubb DBA The company dba name
name Hubb The name for the company
tax_id douglas The tax ID for the company
tags Test1,Test2 Tags for the company
street 23 new york st Company Street
city Sunrise The city name for the company Address
country 55 The country ID for the company Address
facebook facebook ULR or Facebook name The Facebook page or name for the company
twitter twitter ULR or twitter name The twitter account for the company
linkedin Linkedin username The Linkedin username account for the company
sector_id 2 The Sector ID for the company
owner_id 4 The Owner ID for the company
employee_range 1-10 The Rang of the Employee inside the company
added_date 2020-08-31 The Creation Date for the company
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&company_emailemail=XXXXX&....etc&screen=1]

Response :

  1. {
  2. "message":"success",
  3. "total_records":"20",
  4. "company_id":"56",
  5. "company_name":"HUBB",
  6. "company_dba":"",
  7. "contact_no":"52",
  8. "logo":"company Picture"
  9. "last_activity":"last activity date"
  10. "page":"page number"
  11. }
  12. ------OR------
  13. {
  14. "error_message":"error message"
  15. }