Skip to main content
Todos os endpoints aceitam o parâmetro fields para projetar a resposta apenas nos campos desejados.

​
Sintaxe

Lista de campos separada por vírgula. Suporta dot notation para projetar campos aninhados. 
GET /orders?fields=id,code,customer.name
GET /trips?fields=id,route.name,vehicle.licensePlate

​
Comportamento

  • Sem fields (ou vazio) — a resposta é retornada completa.
  • Campos desconhecidos são silenciosamente ignorados.
  • Em respostas paginadas ({ data, meta }), a projeção é aplicada a data; meta é preservado.
  • Arrays são percorridos automaticamente — a projeção aplica-se a cada item.

​
Campos Sensíveis

Campos sensíveis (senhas, hashes, tokens) são sempre removidos de qualquer resposta e não podem ser reintroduzidos via fields.