Lead List API

GET

api

lead

list

{org-id}

{cid}

cURL

curl --request GET \
  --url https://api.pingtree.com/api/lead/list/{org-id}/{cid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pingtree.com/api/lead/list/{org-id}/{cid}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pingtree.com/api/lead/list/{org-id}/{cid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pingtree.com/api/lead/list/{org-id}/{cid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pingtree.com/api/lead/list/{org-id}/{cid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pingtree.com/api/lead/list/{org-id}/{cid}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pingtree.com/api/lead/list/{org-id}/{cid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>",
  "leadsList": {},
  "totalRecord": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

Overview

The Lead List API returns a paginated list of leads associated with a specific offer campaign. Use it to pull lead records for reporting dashboards, data exports, CRM syncs, or campaign performance reviews. Results include lead details, status, source attribution, and timestamps.

Endpoint

GET /api/lead/list/{org-id}/{cid}

Segment	Description
`{org-id}`	Your organization (advertiser) unique ID
`{cid}`	The campaign unique ID

Authentication

Include your API token in the Authorization header:

Authorization: Bearer <your-api-token>

Request Parameters

Path Parameters

Parameter	Type	Required	Description
`org-id`	string	Yes	Organization unique ID
`cid`	string	Yes	Campaign unique ID

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number (default: `1`)
`limit`	integer	No	Records per page (default: `10`, max: `100`)
`sort`	string	No	Sort field (e.g. `createdAt`)
`order`	string	No	Sort direction: `asc` or `desc` (default: `desc`)
`search`	string	No	Filter by email, mobile, or name
`from`	string	No	Start date filter (ISO 8601: `YYYY-MM-DD`)
`to`	string	No	End date filter (ISO 8601: `YYYY-MM-DD`)
`leadStatus`	string	No	Filter by status: `accepted`, `unsold`, `rejected`, `duplicate`
`pid`	string	No	Filter by source unique ID

Example Request

curl -G "https://api.pingtree.com/api/lead/list/org_5f1a2b3c/cmp_9z8y7x6w" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  --data-urlencode "page=1" \
  --data-urlencode "limit=25" \
  --data-urlencode "from=2025-08-01" \
  --data-urlencode "to=2025-08-31" \
  --data-urlencode "leadStatus=accepted"

Example Response

{
  "status": 200,
  "message": "Leads retrieved successfully",
  "data": {
    "leads": [
      {
        "transaction_id": "txn_7f3a2b1c-4d56-78ef-9012-abcdef123456",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane.doe@example.com",
        "mobile": "5551234567",
        "state": "CA",
        "zip_code": "90001",
        "leadStatus": "accepted",
        "isDeDupe": false,
        "pid": "src_abc123",
        "cid": "cmp_9z8y7x6w",
        "sub1": "campaign-abc",
        "createdAt": "2025-08-14T10:32:00.000Z"
      }
    ],
    "totalRecord": 412,
    "page": 1,
    "limit": 25
  }
}

Error — Invalid Campaign

{
  "status": 400,
  "message": "Campaign not found or access denied"
}

Error — Unauthorized

{
  "status": 401,
  "message": "Unauthorized"
}

Status Codes

HTTP Code	Description
200	Lead list returned successfully
400	Invalid campaign ID, org ID, or query parameters
401	Invalid or missing API token
500	Internal server error

Tips

Pagination: Always use the page and limit parameters when working with large campaigns to avoid timeouts. Start at page 1 and increment until you reach all records (totalRecord / limit pages).
Date filters: Use from and to together to pull leads for a specific reporting window. Both accept YYYY-MM-DD format and filter on the lead’s creation timestamp in UTC.
Source filtering: Use the pid parameter to pull leads from a single source within a campaign — useful when comparing source performance.
Status filtering: Combine leadStatus=accepted with date filters for accurate sold-lead counts without pulling rejected or duplicate records.

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

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

Source List APIThe Campaign Source Overview API delivers reporting and statistical data for different lead sources within a campaign. This insight allows marketers to evaluate performance, identify top-performing sources, and refine their strategies accordingly.

cURL

curl --request GET \
  --url https://api.pingtree.com/api/lead/list/{org-id}/{cid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pingtree.com/api/lead/list/{org-id}/{cid}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pingtree.com/api/lead/list/{org-id}/{cid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pingtree.com/api/lead/list/{org-id}/{cid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pingtree.com/api/lead/list/{org-id}/{cid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pingtree.com/api/lead/list/{org-id}/{cid}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pingtree.com/api/lead/list/{org-id}/{cid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>",
  "leadsList": {},
  "totalRecord": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

API Documentation

Offer Campaign APIs

Database Source

Global Event Postback API

Overview

Endpoint

Authentication

Request Parameters

Path Parameters

Query Parameters

Example Request

Example Response

Error — Invalid Campaign

Error — Unauthorized

Status Codes

Tips

Authorizations

Path Parameters

Query Parameters

Response

​Overview

​Endpoint

​Authentication

​Request Parameters

​Path Parameters

​Query Parameters

​Example Request

​Example Response

​Error — Invalid Campaign

​Error — Unauthorized

​Status Codes

​Tips

Authorizations

Path Parameters

Query Parameters

Response

Overview

Endpoint

Authentication

Request Parameters

Path Parameters

Query Parameters

Example Request

Example Response

Error — Invalid Campaign

Error — Unauthorized

Status Codes

Tips