Skip to main content

Parâmetros

As listagens da API pública são paginadas por número de página:
Alguns endpoints de relatório usam outro esquema — Assinaturas Perdidas, por exemplo, pagina por limit e offset. A página de referência de cada endpoint é sempre a palavra final sobre quais parâmetros ele aceita.

O teto de limit varia por endpoint

Não existe um teto único global. Cada listagem tem o seu:
Nunca presuma um teto fixo para a API inteira. Pedir limit acima do teto do endpoint não devolve mais itens — a listagem é limitada ao máximo daquele endpoint.
Se você usa o CaktoMCP, cakto_get_endpoint mostra o teto real da operação consultada, direto do contrato.

O formato da resposta

Toda listagem devolve o mesmo envelope:
Para saber o tamanho total do conjunto, use count. Contar results devolve apenas o tamanho da página atual — com limit=50 e 348 pedidos, results tem 50 itens e count tem 348.
Para percorrer tudo, repita a chamada incrementando page enquanto next não for null.

Pelo CaktoMCP

O cakto_call nunca repassa next/previous crus — são URLs absolutas que o agente não sabe abrir sozinho. O envelope é traduzido para:
Aqui vale a mesma regra: o total é pagination.total, nunca o tamanho de results. Para listar tudo, repita a chamada com query.page igual a next_page enquanto has_more for true. Respostas muito grandes são truncadas — teto de cerca de 50 itens ou 40 KB —, sempre com um aviso em notes dizendo quanto foi cortado e como estreitar o filtro. O corte nunca é silencioso. Detalhes em Ferramentas de Execução.

Próximos passos

Introdução

Busca, filtros e ordenação nas listagens

Limites de Requisição

Quantas páginas você pode pedir por minuto