Lister les leads
curl --request GET \
--url https://app.famulor.de/api/user/leadsimport requests
url = "https://app.famulor.de/api/user/leads"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.famulor.de/api/user/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://app.famulor.de/api/user/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://app.famulor.de/api/user/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://app.famulor.de/api/user/leads")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.de/api/user/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_body{
"current_page": 1,
"data": [
{
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "john.doe@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567899",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "jane.doe.secondary@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04"
}
]
}
],
"first_page_url": "https://app.famulor.de/api/user/leads?page=1",
"from": 1,
"last_page": 10,
"last_page_url": "https://app.famulor.de/api/user/leads?page=10",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.famulor.de/api/user/leads?page=1",
"label": "1",
"active": true
},
{
"url": "https://app.famulor.de/api/user/leads?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://app.famulor.de/api/user/leads?page=2",
"path": "https://app.famulor.de/api/user/leads",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 150
}
Prospects
Lister les leads
Récupère une liste paginée de tous les leads du compte Famulor authentifié via l’API. Filtre, trie et donne accès aux détails de contact pour les campagnes de l’agent vocal.
GET
/
api
/
user
/
leads
Lister les leads
curl --request GET \
--url https://app.famulor.de/api/user/leadsimport requests
url = "https://app.famulor.de/api/user/leads"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.famulor.de/api/user/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://app.famulor.de/api/user/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://app.famulor.de/api/user/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://app.famulor.de/api/user/leads")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.de/api/user/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_body{
"current_page": 1,
"data": [
{
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "john.doe@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567899",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "jane.doe.secondary@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04"
}
]
}
],
"first_page_url": "https://app.famulor.de/api/user/leads?page=1",
"from": 1,
"last_page": 10,
"last_page_url": "https://app.famulor.de/api/user/leads?page=10",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.famulor.de/api/user/leads?page=1",
"label": "1",
"active": true
},
{
"url": "https://app.famulor.de/api/user/leads?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://app.famulor.de/api/user/leads?page=2",
"path": "https://app.famulor.de/api/user/leads",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 150
}
API Famulor 1.0 (héritée). Cette page concerne uniquement Famulor 1.0 (
app.famulor.de) et est conservée pour la compatibilité. Pour la plateforme actuelle, consultez la référence API Famulor 2.0.Paramètres de requête
string
Filtre les leads par statut. Valeurs possibles :
created, scheduled, processing, completed, rescheduled, reached-max-retries, blacklistedinteger
Filtre les leads par identifiant de campagne
string
Filtre les leads par numéro de téléphone (la correspondance partielle est prise en charge)
string
Filtre les leads créés à partir de cette date (format
YYYY-MM-DD)string
Filtre les leads créés jusqu’à cette date (format
YYYY-MM-DD)integer
défaut:"15"
Nombre de leads par page (
1-100)integer
défaut:"1"
Numéro de page
Champs de réponse
array
Liste des leads
Afficher Propriétés du lead
Afficher Propriétés du lead
integer
L’identifiant du lead
integer
L’identifiant de la campagne à laquelle appartient ce lead
string
Le numéro de téléphone du lead au format E.164
object
Les variables attribuées au lead
string
Le statut du lead
string
La date de création du lead
string
La date de la dernière mise à jour du lead
object
array
Tableau des leads de contacts secondaires liés à ce lead
Afficher Propriétés du contact secondaire
Afficher Propriétés du contact secondaire
integer
L’identifiant du lead de contact secondaire
string
Le numéro de téléphone du contact secondaire au format E.164
object
Les variables attribuées au contact secondaire
string
Le statut du contact secondaire
string
La date de création du contact secondaire
string
La date de la dernière mise à jour du contact secondaire
integer
Le numéro de la page actuelle
integer
Nombre d’éléments par page
integer
Nombre total de leads correspondant aux critères
integer
Le numéro de la dernière page
{
"current_page": 1,
"data": [
{
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "john.doe@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567899",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "jane.doe.secondary@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04"
}
]
}
],
"first_page_url": "https://app.famulor.de/api/user/leads?page=1",
"from": 1,
"last_page": 10,
"last_page_url": "https://app.famulor.de/api/user/leads?page=10",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.famulor.de/api/user/leads?page=1",
"label": "1",
"active": true
},
{
"url": "https://app.famulor.de/api/user/leads?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://app.famulor.de/api/user/leads?page=2",
"path": "https://app.famulor.de/api/user/leads",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 150
}
Pages associées : Introduction et Guide d’authentification, et Exemples d’intégration API.
⌘I