Skip to main content
GET
/
v1
/
leads
Listar Leads
curl --request GET \
  --url https://api.integrabot.ai/v1/leads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1234,
      "name": "Maria Silva",
      "type": "whatsapp",
      "phone_number": "5511999998888",
      "email": "maria@exemplo.com",
      "status": "new",
      "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "custom_fields": {
        "empresa": "Acme Ltda"
      },
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T14:22:00Z"
    },
    {
      "id": 1235,
      "name": "João Santos",
      "type": "web",
      "phone_number": null,
      "email": "joao@empresa.com",
      "status": "contacted",
      "agent_id": null,
      "custom_fields": {},
      "created_at": "2025-01-14T09:00:00Z",
      "updated_at": "2025-01-14T11:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 150,
    "last_page": 6
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Filtrar por status do lead.

Available options:
new,
contacted,
qualified,
lost,
converted
type
enum<string>

Filtrar por canal de origem.

Available options:
whatsapp,
email,
web,
manual,
instagram
agent_id
string<uuid>

Filtrar por agent. Use o UUID do agent.

Buscar por nome, e-mail ou telefone.

date_from
string<date>

Data inicial para filtro (formato ISO 8601).

date_to
string<date>

Data final para filtro (formato ISO 8601).

page
integer
default:1

Número da página.

per_page
integer
default:25

Itens por página. Máximo: 100.

Required range: x <= 100

Response

Lista paginada de leads.

data
object[]
meta
object