Skip to main content
Todos os endpoints de listagem da API Vendaze retornam resultados paginados. A resposta sempre inclui um array data e um objeto meta com os detalhes de navegação.

Parâmetros de consulta

Valores aceitos para order_by por recurso

Estrutura da resposta

Campos do meta

Listagem vs. detalhe

Os endpoints de listagem retornam um objeto compacto por registro. Relações embutidas (company, tags, lists) não são incluídas nas respostas de listagem. Use o endpoint GET /:id para obter um registro com todos os dados embutidos.

Percorrendo todas as páginas

Erros de validação

Enviar parâmetros de paginação inválidos retorna um 422 com os erros por campo: