GET
/
api
/
lead
/
list
/
{org-id}
/
{cid}
curl --request GET \
  --url https://api.pingtree.com/api/lead/list/{org-id}/{cid} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>",
  "leadsList": {},
  "totalRecord": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
org-id
string
required

Your organization ID

​
cid
string
required

Your campaign unique ID

Query Parameters

​
page
string

Selected page number default 1

​
limit
string

No of leads in the page, default: 10, min:10, max:100

​
sortField
string

Sort the list of leads based on field default _id

​
sortOrder
string

Sort order of list based on sort field default: descending, valid values are desc , asc

​
date
string
required

For date filter anyone of these combination is rquired ["dateRange","singleDayDate","startDate and endDate"] from below list

​
dateRange
string

Valid date range format YYYY-MM-DD - YYYY-MM-DD

​
startDate
string

Valid startDate format YYYY-MM-DD

​
endDate
string

Valid endDate format YYYY-MM-DD

​
singleDayDate
string

Valid singleDayDate format YYYY-MM-DD

Response

201
application/json
Lead list successfully received
​
status
string

Status code of API response

​
type
string

Type of API response which can be success or error

​
message
string

Message of API response

​
leadsList
object

Lead Details Array

​
totalRecord
string

Total leads count