Listar 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
}
Leads
Listar leads
Recupera una lista paginada de todos los leads de la cuenta de Famulor autenticada a través de la API. Filtra, ordena y consulta los datos de contacto de las campañas del agente de voz.
GET
/
api
/
user
/
leads
Listar 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 de Famulor 1.0 (legado). Esta página se aplica únicamente a Famulor 1.0 (
app.famulor.de) y se conserva por compatibilidad. Para la plataforma actual, usa la referencia de la API de Famulor 2.0.Parámetros de consulta
string
Filtra los leads por estado. Valores posibles:
created, scheduled, processing, completed, rescheduled, reached-max-retries, blacklistedinteger
Filtra los leads por ID de campaña
string
Filtra los leads por número de teléfono (se admite coincidencia parcial)
string
Filtra los leads creados desde esta fecha (formato
YYYY-MM-DD)string
Filtra los leads creados hasta esta fecha (formato
YYYY-MM-DD)integer
predeterminado:"15"
Número de leads por página (
1-100)integer
predeterminado:"1"
Número de página
Campos de respuesta
array
Lista de leads
Mostrar Propiedades del lead
Mostrar Propiedades del lead
integer
El ID del lead
integer
El ID de la campaña a la que pertenece este lead
string
El número de teléfono del lead en formato E.164
object
Las variables asignadas al lead
string
El estado del lead
string
La fecha de creación del lead
string
La fecha de la última actualización del lead
object
array
Array de leads de contacto secundarios vinculados a este lead
Mostrar Propiedades del contacto secundario
Mostrar Propiedades del contacto secundario
integer
El ID del lead de contacto secundario
string
El número de teléfono del contacto secundario en formato E.164
object
Las variables asignadas al contacto secundario
string
El estado del contacto secundario
string
La fecha de creación del contacto secundario
string
La fecha de la última actualización del contacto secundario
integer
El número de página actual
integer
Número de elementos por página
integer
Número total de leads que cumplen los criterios
integer
El número de la última página
{
"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
}
Páginas relacionadas: Introducción y Guía de autenticación, y Ejemplos de integración de la API.