Get Custom Fields of an Activity
This API gives you the details of the Custom Activity Fields you create. To use this API –
- Get the activity Id of the custom activity using the Get Activities of Lead API.
- Pass the activity Id in the URL of this API.
The response will contain the names and values of the all the custom fields under the activity.
Note: 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
GET
https://{host}/v2/ProspectActivity.svc/GetActivityDetails? accessKey=AccessKey&secretKey=SecretKey&activityId=prospectActivityId
URL Parameters
| Parameter | Description |
|---|---|
| prospectActivityId | Id of the activity you want to retrieve the custom fields of. |
Response
200 OK
Content-Type: application/json
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. |
