Ir al contenido

Referencia de API

Errores

La API usa códigos de estado HTTP estándar para indicar el resultado de cada petición.

CódigoSignificado
200 OKPetición exitosa
201 CreatedRecurso creado
400 Bad RequestDatos inválidos o mal formados
401 UnauthorizedFalta el token o es inválido
402 Payment RequiredSin créditos suficientes o con el acceso suspendido por falta de pago
403 ForbiddenSin permiso para el recurso o workspace, o se alcanzó el límite del plan
404 Not FoundEl recurso no existe
409 ConflictConflicto (por ejemplo, un duplicado)
422 Unprocessable EntityDatos válidos, pero la operación no se puede hacer en el estado actual
429 Too Many RequestsSuperaste el rate limit (se abre en una pestaña nueva)
500 Internal Server ErrorError del servidor
503 Service UnavailableUn servicio o módulo no está disponible en este momento; reintenta más tarde

Los errores devuelven success: false y un mensaje descriptivo:

Respuesta 400
{
"success": false,
"message": "name: El campo es obligatorio."
}

En errores de validación, details.issues trae el detalle campo por campo:

Respuesta 400 — varios campos inválidos
{
"success": false,
"message": "email: Correo inválido",
"details": { "issues": [ { "path": ["email"], "message": "Correo inválido" } ] }
}