Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Leads

Listar leads

Lista os leads de acordo com os filtros estabelecidos

get/{alias}/leads

Path parameters

aliasstring required

Alias da loja

Query parameters

namestring

Filtrar por nome

emailstring email

Filtrar por endereço de email

birthdaystring date

Filtrar por data de nascimento

citystring

Filtrar por cidade

statestring

Filtrar por estado

genrestring

Filtrar por gênero

paramsobject

Filtrar por parâmetros adicionais

Response

Lista de leads

Example response

{
  "data": [
    {
      "name": "Nome do Lead",
      "email": "lead@email.com",
      "birthday": "yyyy-mm-dd",
      "city": "São Paulo",
      "state": "SP",
      "genre": "m",
      "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"
      }
    }
  ]
}