Developer API

Build on
BiasharaOS.

A RESTful API with full programmatic access to your business data. Integrate your own tools seamlessly.

Get API Key

Generate your API key from dashboard settings.

Make your first call

Use curl, Postman, or your preferred HTTP client.

Read the docs

Full reference for every endpoint with examples.

Example Request

Terminal / curl
curl -X GET https://api.biasharaos.com/v1/sales \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "sale_01J...",
      "amount": 4500,
      "currency": "KES",
      "payment_method": "mpesa",
      "created_at": "2026-06-11T10:30:00Z"
    }
  ],
  "total": 147,
  "page": 1
}

Available Endpoints

Explore our comprehensive set of RESTful endpoints.

GET/api/v1/salesList all sales transactions
POST/api/v1/salesCreate a new sale
GET/api/v1/inventoryGet inventory items
PUT/api/v1/inventory/:idUpdate stock levels
GET/api/v1/mpesa/transactionsList M-Pesa transactions
POST/api/v1/mpesa/stk-pushTrigger STK Push payment
GET/api/v1/reports/salesGet sales report data
GET/api/v1/staffList staff members

Ready to start building?

Full API documentation with interactive examples is available for all registered developers.

Get API Access