Meta Lead Ads leads
Lists the leads captured from Meta Lead Ads Instant Forms (Facebook / Instagram) on the Facebook Pages linked, in the Pilot Status dashboard, to the key’s WhatsApp number — newest first by Meta’s created_time (ties broken by id, descending). Erased leads are never listed nor counted.
Requires a number-scoped key (or an account-wide key narrowed with x-whatsapp-number-id). OAuth/MCP tokens also need the chat:read permission: the ANALYST role is refused.
id is the Pilot Status lead id (use it on GET /v1/leads/{id}); leadgenId is Meta’s id. createdAt is when the person submitted the form on Meta, not when Pilot Status stored it — a backfilled lead keeps its original date.
consentGiven has three states: true = the person ticked the consent checkbox configured for that form; false = they left it unticked; null = UNKNOWN (no checkbox configured for the form when the lead was stored, or no answer) — never read null as a refusal.
Privacy (PII): a redacted lead (redacted: true) keeps its ids, its attribution (page, form, ad and the resolved ad names) and its status fields, but fullName, email and phone come back null and fields empty. On a RELAY_ONLY number every lead is redacted and the response carries notice: "PII_RELAY_ONLY"; on STORE_X_DAYS only leads whose createdAt is older than the window are redacted. total always counts every lead that matches the filter.
curl --request GET \
--url https://pilotstatus.com.br/v1/leads \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/leads"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/leads', 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://pilotstatus.com.br/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/v1/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/leads")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"leads": [
{
"id": "cmg4x2k9a0001ab12cd34ef56",
"leadgenId": "1234567890123456",
"whatsappNumberId": "num_01HZX...",
"pageId": "102345678901234",
"pageName": "MM Design",
"formId": "987654321098765",
"formName": "Orçamento — Outubro",
"adId": "120249828053880703",
"adName": "Ads 01 - Vídeo dos 70%",
"adsetName": "[IG] [LL1% IG + VÍDEOS] - 35 a 50",
"campaignName": "[CD-01] [LEADS] - MM Design - Sale 70%",
"platform": "ig",
"isOrganic": false,
"createdAt": "2026-10-18T14:32:10.000Z",
"fullName": "Maria Souza",
"email": "maria@example.com",
"phone": "+55 11 91234-5678",
"fields": [
{
"key": "full_name",
"label": "full_name",
"values": [
"Maria Souza"
]
},
{
"key": "qual_ambiente",
"label": "Qual ambiente você quer reformar?",
"values": [
"Cozinha"
]
}
],
"consentGiven": null,
"conversationId": null,
"autoSendStatus": "none",
"autoSendReason": null,
"source": "webhook",
"redacted": false
},
{
"id": "cmg4x2k9a0002ab12cd34ef57",
"leadgenId": "1234567890654321",
"whatsappNumberId": "num_01HZX...",
"pageId": "102345678901234",
"pageName": "MM Design",
"formId": "987654321098765",
"formName": "Orçamento — Outubro",
"adId": null,
"adName": null,
"adsetName": null,
"campaignName": null,
"platform": "fb",
"isOrganic": true,
"createdAt": "2026-10-17T09:05:44.000Z",
"fullName": null,
"email": null,
"phone": null,
"fields": [],
"consentGiven": null,
"conversationId": null,
"autoSendStatus": "none",
"autoSendReason": null,
"source": "backfill",
"redacted": true
}
],
"total": 2,
"page": 1,
"pageSize": 30,
"totalPages": 1
}{
"error": "startDate must be before or equal to endDate",
"code": "INVALID_DATE_RANGE"
}{
"error": "Unauthorized"
}{
"error": "This endpoint acts on a single WhatsApp number: send the x-whatsapp-number-id header naming the number to act on (its id or instance id from GET /v1/numbers) | Este endpoint atua sobre um único número de WhatsApp: envie o header x-whatsapp-number-id indicando o número desejado (o id dele ou o id da instância, obtidos em GET /v1/numbers)",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}Authorizations
Your ps_ API key
Query Parameters
Filter to a single Instant Form id. (string)
Filter to a single ad id. (string)
Filter to a single Facebook Page id. (string)
Start of the date range, over the lead's createdAt (Meta's created_time), inclusive. Must be ≤ endDate.
(string (ISO 8601))
End of the date range, over the lead's createdAt, inclusive.
(string (ISO 8601))
Page (default 1). Values below 1 or non-numeric fall back to 1. (integer (≥1))
Items per page (default 30, max 100; larger values are capped at 100). (integer (1–100))
Response
Leads of the key's number
Was this page helpful?
curl --request GET \
--url https://pilotstatus.com.br/v1/leads \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/leads"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/leads', 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://pilotstatus.com.br/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/v1/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/leads")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"leads": [
{
"id": "cmg4x2k9a0001ab12cd34ef56",
"leadgenId": "1234567890123456",
"whatsappNumberId": "num_01HZX...",
"pageId": "102345678901234",
"pageName": "MM Design",
"formId": "987654321098765",
"formName": "Orçamento — Outubro",
"adId": "120249828053880703",
"adName": "Ads 01 - Vídeo dos 70%",
"adsetName": "[IG] [LL1% IG + VÍDEOS] - 35 a 50",
"campaignName": "[CD-01] [LEADS] - MM Design - Sale 70%",
"platform": "ig",
"isOrganic": false,
"createdAt": "2026-10-18T14:32:10.000Z",
"fullName": "Maria Souza",
"email": "maria@example.com",
"phone": "+55 11 91234-5678",
"fields": [
{
"key": "full_name",
"label": "full_name",
"values": [
"Maria Souza"
]
},
{
"key": "qual_ambiente",
"label": "Qual ambiente você quer reformar?",
"values": [
"Cozinha"
]
}
],
"consentGiven": null,
"conversationId": null,
"autoSendStatus": "none",
"autoSendReason": null,
"source": "webhook",
"redacted": false
},
{
"id": "cmg4x2k9a0002ab12cd34ef57",
"leadgenId": "1234567890654321",
"whatsappNumberId": "num_01HZX...",
"pageId": "102345678901234",
"pageName": "MM Design",
"formId": "987654321098765",
"formName": "Orçamento — Outubro",
"adId": null,
"adName": null,
"adsetName": null,
"campaignName": null,
"platform": "fb",
"isOrganic": true,
"createdAt": "2026-10-17T09:05:44.000Z",
"fullName": null,
"email": null,
"phone": null,
"fields": [],
"consentGiven": null,
"conversationId": null,
"autoSendStatus": "none",
"autoSendReason": null,
"source": "backfill",
"redacted": true
}
],
"total": 2,
"page": 1,
"pageSize": 30,
"totalPages": 1
}{
"error": "startDate must be before or equal to endDate",
"code": "INVALID_DATE_RANGE"
}{
"error": "Unauthorized"
}{
"error": "This endpoint acts on a single WhatsApp number: send the x-whatsapp-number-id header naming the number to act on (its id or instance id from GET /v1/numbers) | Este endpoint atua sobre um único número de WhatsApp: envie o header x-whatsapp-number-id indicando o número desejado (o id dele ou o id da instância, obtidos em GET /v1/numbers)",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}