Respostas e erros

Envelope padrão

A maioria dos endpoints responde no formato:

// sucesso
{
    "code": 200,
    "success": true,
    "data": {},
    "message": "Mensagem opcional"
}

// erro
{
    "code": 422,
    "success": false,
    "data": { "campo": ["mensagem de validação"] },
    "message": "Descrição do erro"
}

• success — sempre indica se a chamada deu certo.
• data — o recurso retornado (sucesso) ou os detalhes do erro por campo (falha). Pode ser null.
• A chave do recurso pode variar em alguns endpoints (user, users, data, ...); está indicada na descrição de cada um.

Códigos HTTP

Código	Significado
200	OK.
201	Criado.
204	OK, sem conteúdo (comum em DELETE).
400	Requisição inválida.
401	Token ausente, inválido ou expirado.
403	Sem permissão para o recurso.
404	Recurso não encontrado.
422	Falha de validação — veja data para os campos.
429	Muitas requisições.
500	Erro interno.

Paginação

Endpoints de listagem aceitam, quando aplicável, os parâmetros de query:

Parâmetro	Descrição
page	Página desejada (começa em 1).
per_page	Itens por página.
search	Texto livre de busca.
start_date / end_date	Recorte por período (formato YYYY-MM-DD).

A resposta de listagens paginadas inclui os metadados current_page, last_page, per_page e total.

Formato de datas e valores

• Datas em YYYY-MM-DD (e YYYY-MM-DD HH:MM:SS quando há hora).
• Valores monetários em centavos (inteiro) ou em reais (decimal), conforme indicado em cada endpoint — confira antes de enviar.