Skip to main content
As respostas da API seguem um formato comum, em JSON. Esta página mostra os campos que indicam se a requisição deu certo e, quando dá errado, os campos que dizem qual foi o erro.

​
Resposta de sucesso

Uma resposta de sucesso traz response com o valor true, ao lado dos dados pedidos:
​
boolean
required
true quando a requisição fez o que foi pedido.
Os demais campos dependem do endpoint. No exemplo, a listagem de projetos devolve a lista em projects. A referência de cada endpoint mostra os campos da resposta.

​
Resposta de erro

Uma resposta de erro traz response com o valor false e o identificador do erro em message:
​
boolean
required
false quando a requisição não foi concluída.
​
string
required
Identificador do erro, em inglês, que a sua integração usa para tratar cada caso. Exemplos: unauthorized, validation_errors, project_model_not_found.
​
string
Descrição legível do erro. Vem na maioria dos erros.
Para decidir se a requisição deu certo, confira o campo response, e não só o status HTTP.

​
Erros de validação

Quando um campo do corpo ou da URL tem valor inválido ou está faltando, a API responde com HTTP 422, message: "validation_errors" e o campo validation:
​
object
Mapa em que cada chave é o nome de um campo com problema e cada valor é a lista de mensagens daquele campo. Corrija os campos listados e envie a requisição de novo.

​
Campos extras em alguns erros

Alguns erros trazem campos a mais, com o detalhe necessário para resolver o problema. Por exemplo, a falta de permissão (permission_required) traz em permission a permissão que faltou. A referência de cada endpoint mostra os erros que ele pode devolver.

​
Páginas relacionadas

Estas páginas complementam a estrutura de respostas: