Skip to main content

Error Handling

The API uses standard HTTP status codes and returns error details in the response body.

Error Response Format

{
  "error": "Error message",
  "code": "ERROR_CODE",
  "details": {
    "field": "Additional error details"
  }
}

HTTP Status Codes

Status CodeMeaning
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limit Exceeded
500Internal Server Error

Common Error Codes

  • UNAUTHORIZED: Invalid or missing authentication
  • FORBIDDEN: Insufficient permissions
  • NOT_FOUND: Resource not found
  • VALIDATION_ERROR: Request validation failed
  • RATE_LIMIT_EXCEEDED: Rate limit exceeded
Scope: Tenant-scoped; requires authenticated org context
Availability: Not available in SuperAdmin


Permissions & Roles

Error responses include details about what went wrong. Check the error code and message for guidance on resolving issues.