# API - Chamada para listar os leads da instância procurando um campo específico

## Introdução

Endpoint completo: [https://sprinthub-api-master.sprinthub.app/](https://sprinthub-api-master.sprinthub.app/leads?i=instancia/leadsadvanced)[leadsadvanced](https://sprinthub-api-master.sprinthub.app/leads?i=instancia/leadsadvanced)[?i=instancia](https://sprinthub-api-master.sprinthub.app/leads?i=instancia/leadsadvanced)

i = nome da sua instância

Requisição do tipo: <mark style="color:red;">**POST**</mark>

### Exemplo em JSON

**Body**

```
{
    "query": "{leads{id,fullname,email,whatsapp,mobile}}",
    "search": "teste@gmail.com"
}
```

#### Corpo da Requisição

O corpo da requisição será do tipo JSON e deve incluir dois campos principais: `query` e `search`.

1. **query**: Este campo especifica as informações que queremos recuperar sobre os leads. No exemplo abaixo, estamos interessados em obter os campos `id`, `fullname`, `email`, `whatsapp` e `mobile`.
2. **search**: Este campo permite filtrar os resultados com base em um critério de pesquisa. No exemplo, estamos procurando um lead com o e-mail `teste@gmail.com`.

### Exemplo de chamada da API

Vamos agora ver como fazer essa chamada de API usando Postman:

```
{
    "data": {
        "leads": [
            {
                "id": 2059,
                "fullname": "Teste 2",
                "email": "teste@gmail.com",
                "whatsapp": null,
                "mobile": null
            }
        ]
    }
}
```

{% hint style="info" %}
Se o Search não for especificado, no JSON será mostrado todos os campos da query de alguns leads.
{% endhint %}

### Conclusão

Neste artigo, vimos como fazer uma chamada de API para obter leads usando o SprintHub. Utilizamos um endpoint específico e um corpo de requisição JSON para listar leads e buscar informações específicas. Experimente com diferentes critérios de pesquisa para atender às suas necessidades específicas.