GET
/
{alias}
/
leads
curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/leads \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'
{
  "data": [
    {
      "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.000000",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "updated_at": {
        "date": "2000-08-17 10:24:24.000000",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": "10",
      "count": "30",
      "per_page": "10",
      "current_page": "1",
      "total_pages": "3",
      "links": {
        "previous": "",
        "next": ""
      }
    }
  }
}

Authorizations

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

Path Parameters

​
alias
string
required

Alias da loja

Query Parameters

​
name
string

Filtrar por nome

​
email
string

Filtrar por endereço de email

​
birthday
string

Filtrar por data de nascimento

​
city
string

Filtrar por cidade

​
state
string

Filtrar por estado

​
genre
string

Filtrar por gênero

​
params
object

Filtrar por parâmetros adicionais

Response

200
application/json

Lista de leads

Representa uma paginação com meta