Activities

/Activities endpoints enable management of activities in CMap.

Get Activities

HTTP GET v1/Activities?due=-1|0|n

Returns all the activities for the logged on users that are due in the number of days passed in. For all overdue activities pass in -1, for activities due today pass in 0, for activities due in the future number of days pass in the number of days - for example passing in 5 will return all activities due in the next 5 days.

If an Activity is marked as Private, or is related to the HR module, it will not show.

Response

[
  { 
  "id": 123, 
  "companyId": "434532", 
  "company": "ABC Pharma", 
  "contactId": 3456, 
  "contactName": "Matt Smith", 
  "details": "The information about the activity", 
  "documentId": "0000-0000-0000-0000", 
  "documentName": "Activity.xlsx", 
  "dueDate": "2017-01-01", 
  "isCompleted": false,
  "leadId": 12345,
  "projectId": 7987, 
  "projectTitle": "10001 - Website Design",
  "type": "Meeting", 
  "typeId": "3",
  "ownerId": 2468,
  "notes": "Activity notes",
  "startDate": "2017-01-01",
  "isPrivate": false
  }
]

Get Activity

HTTP GET v1/Activities/5

Returns the activity for the supplied id if it exists

Response

{ 
  "id": 123, 
  "companyId": "434532", 
  "company": "ABC Pharma", 
  "contactId": 3456, 
  "contactName": "Matt Smith", 
  "details": "The information about the activity", 
  "documentId": "0000-0000-0000-0000", 
  "documentName": "Activity.xlsx", 
  "dueDate": "2017-01-01", 
  "isCompleted": false,
  "leadId": 12345,
  "projectId": 7987, 
  "projectTitle": "10001 - Website Design",
  "type": "Meeting", 
  "typeId": "3",
  "ownerId": 2468,
  "notes": "Activity notes",
  "startDate": "2017-01-01",
  "isPrivate": false
}