La API utiliza códigos de estado HTTP estándar para indicar éxito o error. Las respuestas de error incluyen un campo detail con un mensaje legible para personas.
Formato de respuesta de error
{
"detail": "Company not found"
}
Para errores de validación, la respuesta incluye detalles a nivel de campo:
{
"detail": [
{
"loc": ["body", "work_email"],
"msg": "value is not a valid email address",
"type": "value_error.email"
}
]
}
Códigos de estado
Éxito
Código
Significado
Usado por
200
OK
GET, PATCH, DELETE
201
Creado
POST
Errores del cliente
Código
Significado
Causas comunes
400
Solicitud incorrecta
Faltan campos requeridos, valores de campo inválidos, ningún campo en la actualización
401
No autorizado
API key ausente o inválida, API key expirada, se proporcionó un token JWT en lugar de una API key
404
No encontrado
El recurso no existe o fue eliminado
422
Entidad no procesable
El cuerpo de la solicitud no supera la validación (tipos incorrectos, formato de correo inválido)