This guide explains the standard structure of API responses in our system. All endpoints follow this schema to ensure consistency and predictability.

1. Response Structure Components 🧩

  • Status Code 🌐
    HTTP status codes (e.g., 200 OK, 404 Not Found) indicate request success or errors.

    Status Code

  • Body 📦
    The main payload contains data. For example: 

    {
  "data": { ... },
  "message": "Operation successful"
}

    Response Body

  • Metadata 📝
    Additional information like pagination or timestamps: 

    {
  "page": 1,
  "total_pages": 5,
  "created_at": "2023-10-05T14:48:00Z"
}

    Metadata Example

2. Best Practices ✅

  • Always validate input parameters before processing
  • Use consistent naming conventions for fields
  • Include error details in 4xx/5xx responses

For more examples, see our API Overview page.
Explore Request Schema for complementary information.