> For the complete documentation index, see [llms.txt](https://docs.floui.io/guia/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.floui.io/guia/conectores/categorias/servicos-externos/sankhya/endereco/consultar-bairros.md).

# Consultar bairros

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="/files/oXQC1EHm6pwVlaARmagX" alt="" width="370"><figcaption><p>Parâmetros de configuração.</p></figcaption></figure>

<table><thead><tr><th width="229">Campo</th><th width="129" align="center">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>Conta de serviço</td><td align="center">Select</td><td>Permite o acesso ao sistema através de credenciais fornecidas no painel de contas do Floui.</td></tr><tr><td>Filtro por campo</td><td align="center">String</td><td>Utilize campos internos para aplicar filtros de buscas.</td></tr><tr><td>Valor</td><td align="center">String</td><td>Define um valor associado ao filtro por campo.</td></tr><tr><td>Tipo do valor</td><td align="center">Select</td><td>Define o tipo primitivo do valor aplicado. </td></tr><tr><td>Campos para retorno na consulta</td><td align="center">String</td><td>Crie a sua estrutura de retorno esperada usando os campos internos.</td></tr><tr><td>Número de resultados por página</td><td align="center">String</td><td>Define um número de itens encontrados por página.</td></tr><tr><td>Página atual</td><td align="center">String</td><td>Define a página de visualização padrão.</td></tr><tr><td>Retorno em modo simplificado</td><td align="center">Select</td><td>Retorna os dados de resultado da consulta em modo simplificado ao invés da resposta padrão da Sankhya.</td></tr><tr><td>Output path</td><td align="center">String</td><td>Armazena os dados de saída do conector ao final da execução.</td></tr><tr><td>Descrição</td><td align="center">String</td><td>Mensagem visual para descrever a função do conector no contexto do fluxo.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

{% openapi src="/files/5k0enkGQ84KHRY4am4Q2" path="/Bairro" method="get" %}
[swagger-sankhya-com-br.json](https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FgrC90PpqsLanRipFAD5N%2Fswagger-sankhya-com-br.json?alt=media\&token=dbf196e4-08a0-4ab2-9350-ca86f1b5e9da)
{% endopenapi %}


---

# 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.floui.io/guia/conectores/categorias/servicos-externos/sankhya/endereco/consultar-bairros.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.