Os endpoints de listagem da engineAPI (GET /v1/nfe, GET /v1/nfce, GET /v1/nfse)
compartilham o mesmo contrato de paginação: os mesmos query params, a mesma
validação, o mesmo envelope de resposta.
Query params
sortBy tem uma whitelist de campos permitidos: createdAt, updatedAt, number,
amount, status, vencimento, name. Mandar um valor fora dela não é erro: a
engineAPI silenciosamente ordena por createdAt em vez de rejeitar a requisição.
Envelope de resposta
data[] traz os itens da página atual; pagination traz os metadados de paginação;
meta é o mesmo envelope padrão de toda resposta da engineAPI. limit acima do teto
(> 100) ou page/limit inválidos (?page=abc) nunca viram 500: a engineAPI
sempre clampa para dentro dos limites válidos antes de consultar o banco.
Variante “últimos N”: logs e DLQ de webhooks
Os endpoints de histórico de entregas e Dead Letter Queue de webhooks são a
exceção: não paginam por page, só devolvem os últimos N registros por limit
(1-100, default 50, diferente do default 20 da paginação completa). Sem
sortBy/sortOrder (ordenação fixa: mais recente primeiro) e sem o campo
pagination no envelope. Os dois endpoints, porém, não têm o mesmo shape entre si:
Ver também o guia de Webhooks.
Próximos passos