curl --request GET \
--url https://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/leads \
--header 'X-API-Key: <api-key>'import requests
url = "https://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/leads")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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{
"http_code": 200,
"status": "success",
"message": "Leads retrieved",
"data": {
"items": [
{
"id": 42,
"title": "Acme Corp",
"status_name": "in_progress",
"status_label": "In Progress",
"created_at": "2026-01-10T08:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 25,
"total": 120,
"total_pages": 5
}
}
}{
"http_code": 401,
"status": "failed",
"message": "Invalid or missing API key"
}{
"http_code": 403,
"status": "failed",
"message": "Insufficient scope"
}{
"http_code": 429,
"status": "failed",
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Try again after the reset time."
}
}List leads
Returns a paginated list of leads for your agency.
All filters below are optional and combine with AND. pagination.total and pagination.total_pages always describe the filtered result set, not the whole workspace.
curl --request GET \
--url https://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/leads \
--header 'X-API-Key: <api-key>'import requests
url = "https://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/leads")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flozy-backend-1042419926531.us-central1.run.app/api/v1/external/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{
"http_code": 200,
"status": "success",
"message": "Leads retrieved",
"data": {
"items": [
{
"id": 42,
"title": "Acme Corp",
"status_name": "in_progress",
"status_label": "In Progress",
"created_at": "2026-01-10T08:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 25,
"total": 120,
"total_pages": 5
}
}
}{
"http_code": 401,
"status": "failed",
"message": "Invalid or missing API key"
}{
"http_code": 403,
"status": "failed",
"message": "Insufficient scope"
}{
"http_code": 429,
"status": "failed",
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Try again after the reset time."
}
}Authorizations
Your Flozy API key. Starts with flz_live_.
Query Parameters
Page number.
x >= 1Results per page (max 100).
1 <= x <= 100Sort direction.
asc, desc Full-text search.
Keep only leads with this status. Send a name from GET /lead-statuses. Names are slugified before matching, so In Progress, in-progress and in_progress are equivalent. Unlike PUT /leads/{id}/status, filtering never creates a status — an unknown name simply matches no leads.
100"in_progress"
Keep only leads that have at least one opportunity in this pipeline. Leads have no pipeline of their own — the relationship runs through /opportunities, so a lead with no opportunity is never matched. Ids come from GET /pipelines; an id belonging to another agency matches nothing.
x >= 11
Keep only leads created on or after this date. Format is YYYY-MM-DD — a date-time is rejected, not truncated. The bound is inclusive and compares calendar dates in the workspace timezone.
"2026-01-01"
Keep only leads created on or before this date. Same format and rules as created_after; also inclusive, so passing the same value for both returns exactly that day.
"2026-12-31"
Response
Paginated list of leads.