Search Knowledge Base Articles

Lead - Search By Dates Range [code]

GET 
api/leads/dates/{from_date}/{to_date}

Header

Field Type Description
Authtoken String Basic Access Authentication token.

Parameters

Field Type Description
from_date String format: YYYY-MM-DD (e.g. 2021-01-31)
to_date String format: YYYY-MM-DD (e.g. 2021-01-31)

Success Response (200)

Field Type Description
Lead Object Lead information. 
HTTP/1.1 200 OK
{
  "id": "17",
  "hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
  "name": "Lead name",
  "contact": "",
  "title": "",
  "company": "Gap Trade",
  "description": "",
  "country": "243",
  "city": "London",
  "state": "London",
  "address": "1a The Alexander Suite Silk Point",
  "assigned": "5",
  "dateadded": "2019-07-18 08:59:28",
  "status": "0",
  "source": "4",
  ...
}

Error Response (4xx)

Name Type Description
status Boolean Request status.
message String No data were found. 
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "No Data Found."
}

Lead Status Definitions

PLEASE NOTE

Check for the statuses your crm has. All the statuses have the numerical index - ID. The index must go in the curl request, not the name. 

To find the leads' IDs: Setup-> Leads-> Sources

https://crm.podcator.com/knowledge-base/article/leads-status

Related Endpoints

Please follow the "status" field from our API for updated lead statuses.

Did you find this article useful?

Related Articles