Get Leads by Date Range
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns the list of leads updated in a specific date range. The maximum number of leads returned through a single call is 5000.
Note: The supported DateTime format is UTC (YYYY-MM-DD HH:MM:SS).
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/Leads.RecentlyModified?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"Parameter":{
"FromDate":"2016-09-05 02:00:00",
"ToDate":"2016-09-08 02:20:00"
},
"Columns":{
"Include_CSV":"ProspectID,FirstName,LastName,EmailAddress"
},
"Paging":{
"PageIndex":1,
"PageSize":100
},
"Sorting":{
"ColumnName":"ProspectAutoId",
"Direction":"1"
}
}
Request Parameters
| Parameter | Description |
|---|---|
| FromDate | The start date of your search in UTC (YYYY-MM-DD HH:MM:SS). |
| ToDate | The end date of your search in UTC (YYYY-MM-DD HH:MM:SS). |
| Include_CSV | The fields you want to include if you’re exporting to CSV.
|
| 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 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. |
| Sorting | For the column you’re looking to sort, passing “1” will sort the most recent data first, while “0” will sort the oldest first. |
Response
200 OK
Content-Type: application/json
{
"RecordCount": 1,
"Leads": [
{
"LeadPropertyList": [
{
"Attribute": "ProspectID",
"Value": "ed477dea-d2fe-11e6-b5f1-22000aa8e760"
},
{
"Attribute": "FirstName",
"Value": "John"
},
{
"Attribute": "LastName",
"Value": "Smith"
},
{
"Attribute": "EmailAddress",
"Value": "johnsmith31@acmecorp.com"
},
{
"Attribute": "CanUpdate",
"Value": "true"
}
]
}
]
}
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. |
