Get Leads by Tags

This API retrieves all the leads related to a tag. It returns the Lead Number of the leads.

The “LeadNumber or “LeadAutoId” can be retrieved using “Get Lead by Id” API at this GetLeadByID as “ProspectAutoId”.

API URL

GET
https://{host}/v2/LeadManagement.svc/GetLeadsByTag?accessKey=AccessKey&secretKey=SecretKey&tag=TagName
Copy URL

URL Parameters

Parameter Description
TagName Specify the tag name you want to search for the associated leads.

Response

200 OK

Content-Type: application/json

[
  "5",
  "6",
  "12",
  "305"
]

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.