.png?fit=max&auto=format&n=PYj-p9lRwfHX4QQS&q=85&s=967f00940a17d1d8cc11bd8995dc98d0)
.png?fit=max&auto=format&n=PYj-p9lRwfHX4QQS&q=85&s=5072033d90dfd5e7cc9349712ea4e145)
List Leads
curl --request GET \
--url https://api.example.com/v1/leadsimport requests
url = "https://api.example.com/v1/leads"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/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://api.example.com/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/leads"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/leads")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyLeads
List Leads
Returns a paginated list of leads in your workspace.
GET
/
v1
/
leads
List Leads
curl --request GET \
--url https://api.example.com/v1/leadsimport requests
url = "https://api.example.com/v1/leads"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/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://api.example.com/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/leads"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/leads")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyList Leads
Returns a paginated list of leads in your workspace. Supports search and filtering.Request
GET /v1/leads
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number (default: 1) |
per_page | integer | No | Results per page, max 100 (default: 25) |
search | string | No | Search across name, email, phone, and company |
status | string | No | Filter by status (pending, calling, connected, etc.) |
campaign_id | uuid | No | Filter by campaign ID |
call_outcome | string | No | Filter by call outcome disposition |
ids | string | No | Comma-separated list of lead UUIDs for batch retrieval (max 100). When provided, pagination and other filters are ignored. |
Example
curl -X GET \
"https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/leads?page=1&per_page=10&search=acme" \
-H "Authorization: Bearer rchd_live_xxxxxxxxxxxx"
const params = new URLSearchParams({
page: "1",
per_page: "10",
search: "acme"
});
const response = await fetch(
`https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/leads?${params}`,
{
headers: {
"Authorization": "Bearer rchd_live_xxxxxxxxxxxx"
}
}
);
const { data, meta } = await response.json();
import requests
response = requests.get(
"https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/leads",
headers={"Authorization": "Bearer rchd_live_xxxxxxxxxxxx"},
params={"page": 1, "per_page": 10, "search": "acme"}
)
result = response.json()
Batch retrieval by IDs
curl -X GET \
"https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/leads?ids=uuid1,uuid2,uuid3" \
-H "Authorization: Bearer rchd_live_xxxxxxxxxxxx"
const leadIds = ["uuid1", "uuid2", "uuid3"];
const response = await fetch(
`https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1/leads?ids=${leadIds.join(",")}`,
{ headers: { "Authorization": "Bearer rchd_live_xxxxxxxxxxxx" } }
);
const { data } = await response.json();
Response
{
"data": [
{
"id": "a1b2c3d4-...",
"first_name": "John",
"last_name": "Doe",
"email": "john@acme.com",
"phone": "+33612345678",
"company_name": "Acme Corp",
"status": "pending",
"call_outcome": null,
"total_calls": 0,
"created_at": "2026-03-21T10:00:00.000Z"
}
],
"meta": {
"page": 1,
"per_page": 10,
"total": 1
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
data | array | Array of lead objects |
meta.page | integer | Current page number |
meta.per_page | integer | Items per page |
meta.total | integer | Total number of matching leads |