Skip to main content
GET
/
{alias}
/
search
/
leads
Listar Leads retornados pela busca
curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/search/leads \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'
{
  "id": 123,
  "merchant_id": "1",
  "name": "Nome do Lead",
  "email": "lead@email.com",
  "birthday": "yyyy-mm-dd",
  "city": "São Paulo",
  "state": "SP",
  "genre": "m",
  "utm_source": "",
  "utm_campaign": "",
  "utm_medium": "",
  "utm_term": "",
  "utm_content": "",
  "params": {
    "foo": "Bar",
    "param2": "Param2Value"
  },
  "is_customer": "true",
  "customer_id": "123",
  "customer_since": "yyyy-mm-dd",
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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
​
merchant_id
integer
read-only
Example:

"1"

​
name
string
Example:

"Nome do Lead"

​
email
string
Example:

"lead@email.com"

​
birthday
string<date>
Example:

"yyyy-mm-dd"

​
city
string
Example:

"São Paulo"

​
state
string
Example:

"SP"

​
genre
string
Example:

"m"

​
utm_source
string
Example:

""

​
utm_campaign
string
Example:

""

​
utm_medium
string
Example:

""

​
utm_term
string
Example:

""

​
utm_content
string
Example:

""

​
params
string
Example:
{ "foo": "Bar", "param2": "Param2Value" }
​
is_customer
boolean
Example:

"true"

​
customer_id
integer
Example:

"123"

​
customer_since
string<date>
Example:

"yyyy-mm-dd"

​
created_at
object
​
updated_at
object