Standard response envelope
All API responses share a consistent structure:| Field | Type | Description |
|---|---|---|
success | boolean | true on success, false on error |
message | string | Human-readable message (always present on errors) |
data | object / array | Response payload (present on success) |
Paginated responses
List endpoints return paginated results:page query parameter to navigate pages:
Error responses
Validation error (422):HTTP status codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No content (delete operations) |
| 401 | Unauthenticated |
| 403 | Forbidden (insufficient permissions) |
| 404 | Not found |
| 422 | Validation error |
| 429 | Rate limit exceeded |
| 500 | Server error |