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 protected] email for user to authenticate
password 123456 Password for user to authenticate

Optional Parameters for Search/Filter Sample Description
id 876566 the contact id
contact_email [email protected] email for the contact
phone 5645645456 The phone number for the contact
firstname mike The first name for the contact
lastname douglas The last name for the contact
timestamp_last_activity 2020-11-12 18:14:06 Last Activity time for the contact
company_name company XY Company Name
facebook facebook ULR or Facebook name The Facebook page or name for the contact
twitter twitter ULR or twitter name The twitter account for the contact
skype skype username The skype username account for the contact
linkedin Linkedin username The Linkedin username account for the contact
pinterest pinterest username The pinterest account for the contact
googlePlus googlePlus username The googlePlus account for the contact
instagram instagram username The instagram account for the contact
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 :[&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":"[email protected]",
  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. }