Documentation

Response Format

Standard success, paginated, error, and validation error response structures

Last updated: Feb 09, 2026

Response Format

Success Response

{
  "success": true,
  "message": "Products retrieved successfully",
  "data": { ... },
  "meta": {
    "timestamp": "2026-02-08T18:00:00+00:00",
    "version": "v1"
  }
}

Paginated Response

{
  "success": true,
  "message": "Products retrieved successfully",
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 150,
    "last_page": 8,
    "from": 1,
    "to": 20,
    "timestamp": "2026-02-08T18:00:00+00:00",
    "version": "v1"
  },
  "links": {
    "first": "http://domain.com/api/v1/products?page=1",
    "last": "http://domain.com/api/v1/products?page=8",
    "prev": null,
    "next": "http://domain.com/api/v1/products?page=2"
  }
}

Error Response

{
  "success": false,
  "message": "Invalid credentials",
  "error_code": "INVALID_CREDENTIALS",
  "errors": null,
  "meta": {
    "timestamp": "2026-02-08T18:00:00+00:00",
    "version": "v1"
  }
}

Validation Error Response

{
  "success": false,
  "message": "Validation failed",
  "error_code": "VALIDATION_ERROR",
  "errors": {
    "email": ["The email field is required."],
    "password": ["The password must be at least 8 characters."]
  },
  "meta": {
    "timestamp": "2026-02-08T18:00:00+00:00",
    "version": "v1"
  }
}