// API docs

API documentation

Everything you need to integrate with Tarello features. Start at "Getting started" or jump straight to the feature you will use.

Errors

Todos os erros da API Tarello retornam um JSON com a mesma estrutura, facilitando o tratamento no cliente.

Formato

{
  "error": {
    "code": "validation_error",
    "message": "O campo 'email' é obrigatório.",
    "field": "email",
    "request_id": "req_8f4a2b1c"
  }
}

Campos:

  • code — identificador estável do tipo de erro (use no seu código)
  • message — descrição humana, no idioma do header Accept-Language
  • field — opcional, presente em erros de validação
  • request_id — id único da requisição, útil para suporte

Códigos HTTP usados

Códigos de erro mais comuns

  • validation_error — campo inválido
  • not_found — recurso inexistente
  • unauthorized — JWT ausente ou inválido
  • forbidden — sem permissão
  • rate_limited — limite de requisições atingido
  • conflict — conflito de estado