Records API

Organizations

An organization is any contracted entity whose records you process — hospitals, clinics, labs, pharmacies, insurers, EMR vendors, and government programmes.

The Records API is multi-tenant. Every record belongs to exactly one organization. Your access token is scoped to the organizations your account is linked to — you cannot see or affect anyone else's data.

List linked organizations#

GET/v1/organizations

Returns the organizations the current token is permitted to act on.

200 OK

json

{
  "organizations": [
    {
      "organization_id": "org_lagos_general_clinic",
      "name": "Lagos General Clinic",
      "type": "CLINIC",
      "address": { "street": "14 Adeola Street", "lga": "Ikeja", "state": "Lagos" },
      "stats": {
        "records_processed": 12450,
        "records_validated": 11203,
        "records_in_review": 89
      }
    }
  ],
  "pagination": { "total": 47, "page": 1, "per_page": 50 }
}

Organization types#

Type	Examples
HOSPITAL	Tertiary hospitals, teaching hospitals
CLINIC	Outpatient clinics, polyclinics, PHCs
LAB	Diagnostic laboratories
PHARMACY	Retail and hospital pharmacies
INSURER	Health insurers, HMOs, payers
EMR_VENDOR	EMR / EHR software vendors
HMS_VENDOR	HMS software vendors
GOVERNMENT	Ministries of Health, public health programmes
OTHER	Cooperatives, networks, community programmes

Retrieve one organization#

GET/v1/organizations/:id

Returns the full record for one organization, including site breakdown when the organization has multiple physical locations.