> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/topicos/api/api-chamada-api-para-listar-leads-e-campos-de-leads/api-chamada-para-listar-os-leads-da-instancia-procurando-um-campo-especifico.md).

# 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sprinthub.com/topicos/api/api-chamada-api-para-listar-leads-e-campos-de-leads/api-chamada-para-listar-os-leads-da-instancia-procurando-um-campo-especifico.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.