Status de retornos

A tabela abaixo especifica os status code que podem retornar após uma requisição na API:

Código de retornoMensagem (message)Descrição / comentário
200OKA requisição foi bem sucedida.
201CreatedA requisição foi bem sucedida e um novo recurso foi criado.
202AcceptedUsado para tarefas assíncronas. A solicitação foi aceita para o processamento, mas o resultado real deve ser obtido de outra chamada de API.
204No ContentA requisição foi bem sucedida, mas não tem nada para retornar. Geralmente é utilizada como resposta para requisições DELETE.
400Bad RequestA requisição é inválida. A causa do erro vai descrita no corpo do retorno.
401UnauthorizedAutenticação falhou.
402Payment RequiredA conta vinculada ao token do usuário está com a validade expirada. Entre em contato com os administradores da conta.
403ForbiddenO usuário não tem acesso ao recurso. Verifique o nível do usuário (Consultor ou Gestor).
404Not FoundO usuário está fazendo uma requisição para algo que não existe.
422Unprocessable EntityO usuário tem um problema com os dados enviados.
429Too Many RequestsO usuário enviou muitas requisições.
A API aceita 120 requisições a cada 30 segundos.
500Internal Server ErrorAlgo deu errado em nossa infraestrutura.
503Temporarily unavailableEssa resposta geralmente é retornada quando o sistema está em manutenção.
524A Timeout OccurredEssa resposta é retornada quando a requisição excede o tempo limite.

Por padrão, o gateway da API cancela as requisições que tem duração acima de 60 segundos. Para resolver, uma boa prática é utilizar o parâmetro query de paginação na requisição, insendo um ?show=000&page=000 ao final da URL.