search

Descrição do Modelo de Request para Consultar Contas

Este modelo de request é utilizado para consultar contas no sistema. O request pode conter dois parâmetros principais: filters, sort. A seguir, detalhamos o funcionamento de cada um desses parâmetros.

Paginando os Resultados

A paginação permite dividir os resultados em páginas, retornando um número limitado de contas por vez. Para utilizar a paginação, os seguintes parâmetros devem ser informados na Query String:

page: Define o número da página a ser retornada.

limit: Define a quantidade de resultados por página.

Quando o parâmetro filters for um array vazio, o sistema retornará todas as contas paginadas com base nos parâmetros page e limit.

Filters (Opcional)

O parâmetro filters é opcional. Caso fornecido, ele permite que você defina critérios específicos para filtrar as contas retornadas.

O payload de filters deve conter os seguintes campos:

field: Especifica o campo no qual a consulta será realizada (ex: nome, ID, status).

operator: Define o operador usado para a comparação entre o campo e o valor. Exemplos de operadores são =, like, >, <.

value: O valor que será utilizado para a comparação no campo especificado.

Sort (Opcional)

O parâmetro sort também é opcional. Quando fornecido, ele permite ordenar os resultados com base em um campo e direção definidos.

field: Especifica o campo pelo qual os resultados serão ordenados.

direction: Define a direção da ordenação, podendo ser:

ASC: Ordenação ascendente (do menor para o maior, ou alfabética de A a Z).

DESC: Ordenação descendente (do maior para o menor, ou alfabética de Z a A).

Colunas Liberadas para Consulta

As colunas que podem ser consultadas estão especificadas na documentação de criação de conta. Antes de realizar a consulta, é importante verificar quais colunas estão disponíveis para serem filtradas e ordenadas.

Este modelo de request permite flexibilidade tanto para filtrar e ordenar os dados quanto para paginar os resultados conforme necessário.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
  // "sort": [
  //   {
  //     "field": "created_at",
  //     "direction": "desc"
  //   }
  // ],
  // "filters": [
  //   {
  //     "field": "name",
  //     "operator": "like",
  //     "value": "%d%"
  //   }
  // ]
}

Descrição do Modelo de Request para Consultar Contas#

Paginando os Resultados#

Filters (Opcional)#

Sort (Opcional)#