Skip to main content
GET
Listar leads

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

page
number
padrão:1

Número da página

Intervalo obrigatório: x >= 1
size
number
padrão:20

Tamanho da página

Intervalo obrigatório: 1 <= x <= 100

Termo de pesquisa (full-text search)

name
string

Nome

email
string

Email

phone
string

Telefone

orderBy
padrão:createdAtDesc

Ordenação da lista de leads

createdAtStart
string<date-time>

Data de criação

agentId
string

Identificador do assistente

capture
enum<string>

Status da captura de dados do lead

Opções disponíveis:
completed,
partial

Resposta

Successful response

Página de registros

data
object[]
obrigatório

Lista de registros da página

meta
object
obrigatório

Metadados da página