Listar leads
curl --request GET \
--url https://suasofia.online/api/user/leads \
--header 'Authorization: Bearer <token>'import requests
url = "https://suasofia.online/api/user/leads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://suasofia.online/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://suasofia.online/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",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://suasofia.online/api/user/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://suasofia.online/api/user/leads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://suasofia.online/api/user/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"current_page": 1,
"data": [
{
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "João Silva",
"email": "joao.silva@exemplo.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04",
"campaign": {
"id": 1,
"name": "Minha nova campanha"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567899",
"variables": {
"customer_name": "Maria Silva Secundária",
"email": "maria.silva.secundaria@exemplo.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04"
}
]
}
],
"first_page_url": "https://suasofia.online/api/user/leads?page=1",
"from": 1,
"last_page": 10,
"last_page_url": "https://suasofia.online/api/user/leads?page=10",
"links": [
{
"url": null,
"label": "« Anterior",
"active": false
},
{
"url": "https://suasofia.online/api/user/leads?page=1",
"label": "1",
"active": true
},
{
"url": "https://suasofia.online/api/user/leads?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://suasofia.online/api/user/leads?page=2",
"path": "https://suasofia.online/api/user/leads",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 150
}
Leads
Listar leads
Listar todos os leads para o usuário autenticado com opções de filtragem e paginação.
GET
/
user
/
leads
Listar leads
curl --request GET \
--url https://suasofia.online/api/user/leads \
--header 'Authorization: Bearer <token>'import requests
url = "https://suasofia.online/api/user/leads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://suasofia.online/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://suasofia.online/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",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://suasofia.online/api/user/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://suasofia.online/api/user/leads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://suasofia.online/api/user/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"current_page": 1,
"data": [
{
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "João Silva",
"email": "joao.silva@exemplo.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04",
"campaign": {
"id": 1,
"name": "Minha nova campanha"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567899",
"variables": {
"customer_name": "Maria Silva Secundária",
"email": "maria.silva.secundaria@exemplo.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04"
}
]
}
],
"first_page_url": "https://suasofia.online/api/user/leads?page=1",
"from": 1,
"last_page": 10,
"last_page_url": "https://suasofia.online/api/user/leads?page=10",
"links": [
{
"url": null,
"label": "« Anterior",
"active": false
},
{
"url": "https://suasofia.online/api/user/leads?page=1",
"label": "1",
"active": true
},
{
"url": "https://suasofia.online/api/user/leads?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://suasofia.online/api/user/leads?page=2",
"path": "https://suasofia.online/api/user/leads",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 150
}
Este endpoint permite listar todos os leads pertencentes ao usuário autenticado com várias opções de filtragem e paginação.
Parâmetros de Consulta
string
Filtrar leads por status. Valores possíveis:
created, scheduled, processing, completed, rescheduled, reached-max-retries, blacklistedinteger
Filtrar leads por ID da campanha
string
Filtrar leads por número de telefone (correspondência parcial suportada)
string
Filtrar leads criados a partir desta data (formato YYYY-MM-DD)
string
Filtrar leads criados até esta data (formato YYYY-MM-DD)
integer
Número de leads por página (1-100, padrão: 15)
integer
Número da página (padrão: 1)
Campos de Resposta
array
Show propriedades
Show propriedades
integer
O ID do lead
integer
O ID da campanha à qual este lead pertence
string
O número de telefone do lead no formato E.164
object
As variáveis associadas ao lead
string
O status do lead
string
A data de criação do lead
string
A data de atualização do lead
object
array
Array de leads de contatos secundários associados a este lead
Show propriedades de secondary_contacts
Show propriedades de secondary_contacts
integer
O número da página atual
integer
Número de itens por página
integer
Número total de leads que correspondem aos critérios
integer
O número da última página
{
"current_page": 1,
"data": [
{
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "João Silva",
"email": "joao.silva@exemplo.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04",
"campaign": {
"id": 1,
"name": "Minha nova campanha"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567899",
"variables": {
"customer_name": "Maria Silva Secundária",
"email": "maria.silva.secundaria@exemplo.com"
},
"status": "created",
"created_at": "2025-06-30 11:18:04",
"updated_at": "2025-06-30 11:18:04"
}
]
}
],
"first_page_url": "https://suasofia.online/api/user/leads?page=1",
"from": 1,
"last_page": 10,
"last_page_url": "https://suasofia.online/api/user/leads?page=10",
"links": [
{
"url": null,
"label": "« Anterior",
"active": false
},
{
"url": "https://suasofia.online/api/user/leads?page=1",
"label": "1",
"active": true
},
{
"url": "https://suasofia.online/api/user/leads?page=2",
"label": "2",
"active": false
}
],
"next_page_url": "https://suasofia.online/api/user/leads?page=2",
"path": "https://suasofia.online/api/user/leads",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 150
}
⌘I

