Skip to main content
GET
Listar Leads

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:
web,
telegram,
email,
manual
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