This API is used to list contacts 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
search_key John Doe Type of search in contacts
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 :[&firstname=XXXXX&email=XXXXX&....etc&screen=1]

Response :

  1. {
  2. "message":"success",
  3. "total_records":"20",
  4. "contact_id":"Contact ID",
  5. "contact_name":"Firstname Lastname",
  6. "contact_email":"",
  7. "company_id":"Company ID if the contact assigned to a company",
  8. "company_name":"Company Name",
  9. "phone":"Phone"
  10. "picture":"Contact Picture"
  11. "last_activity":"last activity date"
  12. "page":"page number"
  13. }
  14. ------OR------
  15. {
  16. "error_message":"error message"
  17. }