Get a Lead’s Notes
Returns the notes associated with a lead. To use this API –
- Pass the “RelatedId” (Mandatory) in the JSON body. This is the “LeadId” or the “ProspectId” of the lead whose notes you wish to retrieve.
- Pass the “Id” (Optional) of a particular note you wish to retrieve in the JSON body. If you don’t pass this Id, all the lead’s notes will be retrieved.
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/RetrieveNote?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"Parameter": {
"RelatedId": "06a854bf-cd64-4328-abec-2968fd5e1232",
"Id": "5b25bd3d-cb2f-11e6-b5f1-22000aa8e760"
},
"Paging": {
"PageIndex": 1,
"PageSize": 200
},
"Sorting": {
"ColumnName": "CreatedOn",
"Direction": 1
}
}
Request Parameters
| Parameter | Description |
|---|---|
| RelatedId | Pass the “LeadId” or “ProspectId” of the lead here. |
| Id | Pass the Id of a particular note here. |
| PageIndex | The results matching your criteria may be large. You can fetch the result in blocks of “PageSize” and make multiple calls to the API with increasing values of “PageIndex”. For example, you can specify “PageIndex”: 1, “PageSize”: 100 for the first call and specify “PageIndex”: 2, “PageSize”: 100 for the second call. |
| PageSize | The column on which results will be sorted. For example, if you want results to be shown in descending order of lead creation date then use “CreatedOn” in “ColumnName” and choose “Direction” as “1”. Direction “1” implies descending order and “0” means ascending order. |
| ColumnName | The column on which results will be sorted. For example, if you want results to be shown based on creation date, pass “CreatedOn”. |
| Direction | Direction “1” means descending order and “0” means ascending order. |
Response
200 OK
Content-Type: application/json
{
"List":[
{
"ProspectNoteId":"7d8947bc-0bee-11ed-b7fd-0218d8753a48",
"RelatedProspectId":"153b3aab-7b96-11e9-ae3d-020714094d7e",
"Note":"Test Note",
"AttachmentName":"Dev+Portal+Mockup.pdf",
"AttachmentURL":"https:\/\/f2.leadsquaredcdn.com\/t\/t20170817174751\/content\/module\/lead\/153b3aab-7b96-11e9-ae3d-020714094d7e\/Dev+Portal+Mockup.pdf",
"CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedByName":"Vir Singh",
"CreatedOn":"2022-07-25 07:50:45",
"ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
"ModifiedByName":"Vir Singh",
"ModifiedOn":"2022-07-25 07:50:45"
}
],
"RecordCount":1
}
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. |
