Paginação e filtros

Os padrões abaixo valem para todos os endpoints de listagem da API.

Paginação

ParâmetroTipoPadrãoDescrição
pageinteger1Número da página
perPageinteger20Itens por página (máx. 100)

A resposta traz os registros em data e as informações de paginação em meta:

{
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 20,
    "total": 100
  }
}
📘

Para percorrer todos os registros, incremente page até alcançar last_page. Só considere a sincronização completa depois da última página.

Filtros por intervalo de datas

Filtros de data usam a notação campo[min] / campo[max], sempre no formato Y-m-d:

GET /contas?dataVencimento[min]=2026-01-01&dataVencimento[max]=2026-01-31

Você pode usar só [min], só [max] ou os dois juntos.

Filtros com múltiplos valores

Alguns filtros aceitam mais de um valor com a notação de array campo[]:

GET /locacoes?status[]=Ativa&status[]=Prorrogada

Filtros booleanos

Campos booleanos aceitam true/false:

GET /pagamentos?estornado=false
💡

Dica: combine filtros para reduzir o volume trafegado — ex.: situacao[]=em_aberto + janela de dataVencimento traz só o que interessa, em vez da base inteira.



Did this page help you?