Skip to main content
GET
Listar Leads retornados pela busca

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Response

Lista de leads através da busca

Representa um lead da lista de leads

id
integer

ID do lead.

merchant_id
integer
read-only

ID da loja dona do lead.

Example:

"1"

name
string

Nome do lead.

Example:

"Nome do Lead"

email
string

E-mail informado pelo lead.

Example:

"lead@email.com"

birthday
string<date>

Data de nascimento do lead.

Example:

"yyyy-mm-dd"

city
string

Cidade informada pelo lead.

Example:

"São Paulo"

state
string

Unidade federativa (estado) informada pelo lead.

Example:

"SP"

genre
string

Gênero informado pelo lead: m para masculino e f para feminino.

Example:

"m"

utm_source
string

Origem da campanha de marketing (parâmetro UTM utm_source) que originou o lead.

Example:

""

utm_campaign
string

Nome da campanha de marketing (parâmetro UTM utm_campaign) que originou o lead.

Example:

""

utm_medium
string

Meio/canal de marketing (parâmetro UTM utm_medium) que originou o lead.

Example:

""

utm_term
string

Termo de busca (parâmetro UTM utm_term) que originou o lead.

Example:

""

utm_content
string

Conteúdo do anúncio/link (parâmetro UTM utm_content) que originou o lead.

Example:

""

params
string

Parâmetros adicionais enviados no cadastro do lead, no formato chave-valor.

Example:
is_customer
boolean

Indica se o lead já se tornou cliente da loja.

Example:

"true"

customer_id
integer

ID do cliente correspondente ao lead, quando ele já tiver se tornado cliente da loja.

Example:

"123"

customer_since
string<date>

Data em que o lead se tornou cliente da loja.

Example:

"yyyy-mm-dd"

created_at
object
updated_at
object