Filtros em consultas

O filtro possibilita selecionar um subconjunto específico de resultados de uma requisição.

Caso uma rota de requisição aceite filtros, você poderá acrescentar uma string de consulta (como na paginação) à URL de requisição, para especificar os parâmetros de filtragem.

Para encontrar um usuário de sua conta pelo nome "alex", você deve usar uma string de consulta "name=alex", e sua URL de requisição ficará como a do trecho abaixo:

https://api.pipe.run/v1/users?name=alex

Como este é um filtro parcial (utiliza o LIKE em seu motor), todos os nomes de usuários que contêm a sequência alex, como "Alexia Jones", "Alexandre Santiago" e "Salex Silva" são retornados como resultados.

Você pode utilizar quantos filtros forem necessários para realizar sua consulta. Para utilizar mais de um filtro, adicione um "&" entre eles "name=alex&email=[email protected]".

https://api.pipe.run/v1/users?name=alex&[email protected]

Os endpoints que possuírem filtros disponíveis possuem uma referência documentados em sua descrição e complementos.

No complemento das documentações dos endpoints existem mais informações complementares específicas e exemplos de uso.