Response Format

Tsara business API responses use a consistent top-level envelope.

Success shape

{
  "success": true,
  "status": "success",
  "status_code": 200,
  "message": "OK",
  "data": {}
}

Error shape

{
  "success": false,
  "status": "failed",
  "status_code": 422,
  "message": "Validation failed",
  "errors": {
    "field": ["Field is required."]
  }
}

Notes

  • message is the primary top-level error or success message
  • errors is optional and usually appears on validation failures
  • list endpoints return pagination metadata in meta
  • some endpoints also return endpoint-specific supporting fields at the top level when needed for compatibility

Important correction

If you are updating older Tsara docs, do not document request_id, nested error objects, or pagination as the default envelope unless that page is explicitly for a different external service.