> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeev/apis/como-funcionam-as-apis-rest-no-zeev/filtros-parametricos-para-apis.md).

# Filtros paramétricos para APIs

Outra forma de filtrar uma API é através de filtros paramétricos por meio de chaves

#### Parâmetros

**Parâmetros** para filtrar APIs REST são informações enviadas na requisição (normalmente na URL) para que o servidor retorne apenas os dados que atendem a determinados critérios. Em vez de buscar todos os registros e filtrar depois, você já solicita exatamente o que precisa.

**Query Parameters**

São adicionados após o uso de interrogação `?` na URL. Por exemplo:

`<API> /usuarios?cidade=SãoPaulo`
\
`<API> /pedidos?status=aprovado`
\
`<API> /produtos?precoMin=100&precoMax=500`

Aqui, você está dizendo para a API:

* Traga apenas usuários de São Paulo
* Traga apenas pedidos aprovados
* Traga produtos dentro de uma faixa de preço

**Parâmetros estruturados**

Algumas APIs permitem filtros mais complexos, como:

`GET /usuarios?idade_gt=18`
\
`GET /pedidos?dataInicio=2024-01-01&dataFim=2024-12-31`

Outras usam padrões específicos, como:

* `filter=`
* `search=`
* `q=`

<mark style="background-color:red;">Atenção: isso depende da arquitetura da API.</mark>

**Path Parameters**

Quando você quer um recurso específico. Por exemplo:

`GET /usuarios/123`
\
`GET /pedidos/987`

Aqui não é exatamente “filtro”, mas sim **identificação direta de um recurso**. Neste caso, selecionando um único usuário e um único pedido.

{% embed url="<https://youtu.be/7E-THZuWLD0>" %}

#### Exemplo prático

{% embed url="<https://youtu.be/ekIbGITxh3A>" %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/zeev/apis/como-funcionam-as-apis-rest-no-zeev/filtros-parametricos-para-apis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.