Get Activities of a Lead
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns the activities of a lead (including non-empty custom field values). There are 2 ways to use this API –
- If you want to retrieve a particular activity type, pass the “ActivityEvent” code in the JSON body of the request. You can find activity event codes by navigating to My Account>Settings>Customization>Custom Activities & Scores or by using the Get List of Activity Types API.
- If you want to retrieve all activities of a lead, pass an empty JSON body in the request.
Since different activity types have different data structures, the data that isn’t common between activities is encapsulated in the “Data” parameter of the response, which is a key-value pair of all properties for that activity.
Note:
- This API will retrieve the details of up to 25 activities in a single call. If you want to retrieve more than 25 activities you must pass the pagination parameters.
For example, {“Paging”: {“Offset”: “1”,”RowCount”: “50”}} - You can retrieve files uploaded to a custom object in the activity by passing the additional parameter getFileURL=true in the API URL.
API URL
URL
POST
https://{host}/v2/ProspectActivity.svc/Retrieve?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId
URL Parameters
| Parameter | Description |
|---|---|
| LeadId | Unique Id of the lead record. |
Request
Content-Type: application/jsonJSON Body/Payload
{
"Parameter":{
"ActivityEvent":201
},
"Paging":{
"Offset":"0",
"RowCount":"10"
}
}
Request Parameters
| Parameter | Description |
|---|---|
| ActivityEvent | The unique code associated with each type of activity. It is not mandatory. Not passing an activity code will return all the activities of the lead. |
| Offset | Specifies the page number. |
| RowCount | Specifies the number of results per page. |
Response
200 OK
Content-Type: application/json
{
"RecordCount":2,
"ProspectActivities":[
{
"Id":"c310391d-6784-418b-b61c-bca2d0a7a645",
"EventCode":164,
"EventName":"Custom Object Activity",
"ActivityScore":0,
"CreatedOn":"2018-12-12 10:36:00",
"ActivityType":2,
"IsEmailType":false,
"Type":"Inbound",
"SessionId":"c310391d-6784-418b-b61c-bca2d0a7a645",
"TrackLocation":0,
"Latitude":0,
"Longitude":0,
"RelatedProspectId":"3a6d5ea2-400e-4a2f-a728-fbfa0b0c1ddf",
"Data":[
{
"Key":"CreatedByName",
"Value":"Mangesh V. Devikar"
},
{
"Key":"EventName",
"Value":"Custom Object Activity"
},
{
"Key":"NotableEventDescription",
"Value":""
},
{
"Key":"HasAttachments",
"Value":"False"
}
],
"ActivityFields":{
"mx_Custom_1":"{\"mx_CustomObject_1\":\"bf71914e.png\",\"ModifiedByName\":\"Mangesh V. Devikar \",\"ModifiedOn\":\"2018-12-12 10:39:21\",\"Status\":\"\"}",
"Status":"Active"
},
"ModifiedOn":"2018-12-12 10:57:45"
},
{
"Id":"5c92870f-a337-458f-8be1-0e2458513051",
"EventCode":164,
"EventName":"Custom Object Activity",
"ActivityScore":0,
"CreatedOn":"2018-11-28 06:41:00",
"ActivityType":2,
"IsEmailType":false,
"Type":"Inbound",
"SessionId":"5c92870f-a337-458f-8be1-0e2458513051",
"TrackLocation":0,
"Latitude":0,
"Longitude":0,
"RelatedProspectId":"3a6d5ea2-400e-4a2f-a728-fbfa0b0c1ddf",
"Data":[
{
"Key":"CreatedByName",
"Value":"Mangesh V. Devikar"
},
{
"Key":"EventName",
"Value":"Custom Object Activity"
},
{
"Key":"NotableEventDescription",
"Value":"Lets begin"
},
{
"Key":"HasAttachments",
"Value":"False"
}
],
"ActivityFields":{
"mx_Custom_1":"{\"mx_CustomObject_1\":\"b35f52a3.png,8c06d158.png\",\"mx_CustomObject_2\":\"3bf3b3ff.png\",\"ModifiedByName\":\"Mangesh V. Devikar \",\"ModifiedOn\":\"2018-11-28 03:49:51\",\"Status\":\"Pending\"}",
"Status":"Active",
"Owner":"bf8ce802-836f-11e7-8758-0a106ee76b21"
},
"ModifiedOn":"2018-11-28 03:49:51"
}
]
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
