Skip to main content
GET
/
user
/
leads
Listar leads
curl --request GET \
  --url https://suasofia.online/api/user/leads \
  --header 'Authorization: Bearer <token>'
{
  "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": "&laquo; 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

​
status
string
Filtrar leads por status. Valores possíveis: created, scheduled, processing, completed, rescheduled, reached-max-retries, blacklisted
​
campaign_id
integer
Filtrar leads por ID da campanha
​
phone_number
string
Filtrar leads por número de telefone (correspondência parcial suportada)
​
date_from
string
Filtrar leads criados a partir desta data (formato YYYY-MM-DD)
​
date_to
string
Filtrar leads criados até esta data (formato YYYY-MM-DD)
​
per_page
integer
Número de leads por página (1-100, padrão: 15)
​
page
integer
Número da página (padrão: 1)

​
Campos de Resposta

​
data
array
​
current_page
integer
O número da página atual
​
per_page
integer
Número de itens por página
​
total
integer
Número total de leads que correspondem aos critérios
​
last_page
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": "&laquo; 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
}