This API is used to list activities 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 876566 the task id
assigned_to 22 Task Assignee id
tags Tags The Activity tags
name Hubb The name for the activity
comments douglas The comments for the activity
note Test1 note for the activity
due_date expired Search date
progress 2 The activity progress
contact_id 55 The related contact id
company_id 20 The related company id
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&....etc&screen=1]

Response :

  1. {
  2. "message":"success",
  3. "total_records":"20",
  4. "task_id":"56",
  5. "task_name":"HUBB",
  6. "assign_to":"company",
  7. "owner":"test ",
  8. "related_company":"company "
  9. "related_contact":"contact"
  10. "related_deals":"deal"
  11. "due_date":"due_date"
  12. "date_added":"date_added"
  13. "status":"status"
  14. "page":"page number"
  15. }
  16. ------OR------
  17. {
  18. "error_message":"error message"
  19. }