Skip to content
Medivy Docs

API overview

The Medivy API lets your systems (ERP, internal tools, BI dashboards) read your organization’s data: outlets, products, stock, customers, POS transactions, invoices and revenue reports.

Basics

Section titled “Basics”
  • Base URL: https://api.medivy.id
  • Scope: every endpoint lives under /api/dash/<orgId>/…. An API key works for one organization only.
  • Authentication: send your API key in the x-api-key header. See Authentication.
  • Format: JSON, always over HTTPS.
Terminal window
curl -H "x-api-key: mdv_…" https://api.medivy.id/api/dash/<orgId>/outlets

Response format

Section titled “Response format”

Success:

{ "ok": true, "requestId": "…", "data": { }, "metadata": { } }

Error:

{ "ok": false, "message": "What went wrong" }
Status Meaning
401 The API key is missing, invalid, disabled or expired.
403 The key belongs to another organization, was used from an IP outside its allowlist, or its user lacks the permission for that endpoint.
429 Too many requests from your organization. The limit is generous (about 600 requests per minute per organization); wait briefly and retry.

Endpoint reference

Section titled “Endpoint reference”

The full list of endpoints is in the API reference. It is generated from the code and written in English. Only the endpoints listed there are supported for integrations.