Requests and responses

All requests are JSON over HTTPS to the versioned base URL. Every response uses one envelope, so success and error handling are consistent across endpoints.

Response envelope

Successful responses wrap the payload in data. List endpoints add a meta object with pagination.

{
  "statusCode": 200,
  "success": true,
  "data": { /* ... */ },
  "meta": { "total": 42, "page": 1, "limit": 20, "totalPages": 3 }
}

Pagination

Data formats

• Money is QAR with two decimals, serialized as a fixed-2 string (e.g. "30.00").
• Phone numbers are E.164 (e.g. +97455123456).
• Ids are UUIDs; timestamps are UTC ISO-8601.