LeadSquared Developer Centre

ON THIS PAGE

Get Tasks by Lead Id

This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Run in Postman

Returns all tasks created against a lead. Specify the “LeadId” in the API URL.

Note: This API returns fixed response parameters and you can’t add/remove any parameters in the response.

API URL

URL
Icon
GET https://{host}/v2/LeadManagement.svc/RetrieveTaskByLeadId?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId

URL Parameters

Parameter Description
LeadId Unique identifier of the lead.

Response

200 OK
Content-Type: application/json
{
    "RecordCount": 2,
    "TaskList": [
        {
            "TaskID": "3570a2b8-4363-11e6-b61b-22000aa8e760",
            "Name": "Follow Up With New Lead",
            "Description": "This is test task.",
            "DueDate": "2016-10-20 01:30:00",
            "CreatedOn": "2016-07-06 10:20:05",
            "OwnerID": "190e7b6f-39da-11e6-b61b-22000aa8e760",
            "OwnerName": "User lead",
            "CreatedBy": "7cf19f34-21d6-11e6-8091-02b01d637af7",
            "CreatedByName": "swesh kumar",
            "Status": "Pending",
            "Reminder": "20"
        },
        {
            "TaskID": "ecd28d9b-4443-11e6-b61b-22000aa8e760",
            "Name": "New Talk to the Customer Task",
            "Description": "Good going",
            "DueDate": "2016-07-11 10:12:45",
            "CreatedOn": "2016-07-07 13:08:40",
            "OwnerID": "190e7b6f-39da-11e6-b61b-22000aa8e760",
            "OwnerName": "User lead",
            "CreatedBy": "7cf19f34-21d6-11e6-8091-02b01d637af7",
            "CreatedByName": "swesh kumar",
            "Status": "Pending",
            "Reminder": "15"
        }
    ]
}

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.

On this page

© 2024 by MarketXpander Services Pvt Ltd. All Rights Reserved.