Get Activities of a Lead

Returns the activities of a lead (including non-empty custom field values). There are 2 ways to use this API –

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”}}

API URL

POST
https://{host}/v2/ProspectActivity.svc/Retrieve?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId
Copy URL

URL Parameters

Parameter Description
LeadId Unique Id of the lead record.

Request

JSON Body/Payload

Content-Type: application/json

{
  "Parameter": {"ActivityEvent": 201}
  "Paging": {"Offset": "0","RowCount": "10"}
}

JSON Properties

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": 1,
    "ProspectActivities": [
        {
            "Id": "f17b1706-4477-494b-a73f-33f45742fb09",
            "EventCode": 154,
            "EventName": "Example Custom Activity",
            "ActivityScore": 0,
            "CreatedOn": "2017-11-23 12:16:00",
            "ActivityType": 2,
            "IsEmailType": false,
            "Type": "Inbound",
            "SessionId": "f17b1706-4477-494b-a73f-33f45742fb09",
            "TrackLocation": 0,
            "Latitude": 0,
            "Longitude": 0,
            "RelatedProspectId": "62d4b10d-efec-4635-af97-5f9da8f5a985",
            "Data": [
                {
                    "Key": "CreatedByName",
                    "Value": "Vir Singh"
                },
                {
                    "Key": "EventName",
                    "Value": "Example Custom Activity"
                },
                {
                    "Key": "NotableEventDescription",
                    "Value": ""
                },
                {
                    "Key": "HasAttachments",
                    "Value": "False"
                }
            ],
            "ActivityFields": {}
        }
    ]
}

HTTP Response Code

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.