Paginação

📘

Como funciona

Toda busca da API é um POST .../search paginado: imóveis, pessoas, condomínios, lançamentos, atendimentos, captações, atividades, visitas, propostas, negócios e contratos. São 20 registros por página por padrão, até 100 com perPage.

📄 Como paginar

Envie a página (e, se quiser, o tamanho) no corpo, junto do filtro:

{
  "transactionType": "sale",
  "page": 1,
  "perPage": 50
}

A resposta traz os registros e os metadados de paginação:

{
  "data": [ ... ],
  "total": 137,
  "page": 1,
  "perPage": 50,
  "lastPage": 3
}

Para ler tudo, vá de page: 1 até lastPage.

🔀 Ordenação

Use sort e order para tornar a paginação estável (sem isso, a ordem entre páginas pode variar):

{ "sort": "updatedAt", "order": "asc", "page": 1 }

O padrão é updatedAt decrescente. Os campos de ordenação de cada busca estão na descrição do endpoint.

🔄 Sincronização incremental (recomendado)

Para não reler a base inteira toda vez, combine paginação com um filtro por updatedAt:

{
  "updatedAt": { "from": "2026-08-31T12:00:00Z" },
  "sort": "updatedAt",
  "order": "asc",
  "page": 1
}

Guarde o updatedAt do último registro lido e use como from na próxima rodada. Assim você processa apenas o que mudou.

📘

Veja também

O passo a passo completo de sincronização está em Buscar e sincronizar.