Skip to main content
REST API · v1

DMG QMS API Documentation

A REST API to connect your quality data with your own systems. Read documents, CAPAs, NCRs, audits, risks, suppliers and more into dashboards and reports, and let connected systems such as your ERP raise and update NCRs, complaints and CAPAs. All responses are JSON and strictly scoped to your organisation.

1. Authentication

Every request must include your secret key as a Bearer token. Create and manage keys in the app under **Configuration → API Keys** (admin only).

Authorization: Bearer qms_live_xxxxxxxxxxxxxxxx

Keys are shown in full only once at creation. If a key is lost or compromised, revoke it and create a new one.

2. Base URL & format

https://dmg-qms.com/api/v1

List endpoints return a `data` array plus a `pagination` object. Detail endpoints return a single `data` object. Errors return an `error` object with a message and code.

3. Query parameters (list endpoints)

ParameterDescriptionDefault
pagePage number (1-based)1
limitResults per page (max 100)25
statusFilter by status value—
searchCase-insensitive title / name match—

4. Endpoints

GET/api/v1/meYour organisation & plan
GET/api/v1/documentsList documents
GET/api/v1/documents/{id}Single record by ID
GET/api/v1/capasList capas
GET/api/v1/capas/{id}Single record by ID
GET/api/v1/ncrsList ncrs
GET/api/v1/ncrs/{id}Single record by ID
GET/api/v1/auditsList audits
GET/api/v1/audits/{id}Single record by ID
GET/api/v1/risksList risks
GET/api/v1/risks/{id}Single record by ID
GET/api/v1/suppliersList suppliers
GET/api/v1/suppliers/{id}Single record by ID
GET/api/v1/complaintsList complaints
GET/api/v1/complaints/{id}Single record by ID
GET/api/v1/equipmentList equipment
GET/api/v1/equipment/{id}Single record by ID
GET/api/v1/quality-objectivesList quality objectives
GET/api/v1/quality-objectives/{id}Single record by ID

5. Example

Fetch the 10 most recent open CAPAs:

curl "https://dmg-qms.com/api/v1/capas?status=OPEN&limit=10" \
  -H "Authorization: Bearer qms_live_xxxxxxxxxxxxxxxx"

Response:

{
  "data": [
    {
      "id": "clx...",
      "capaNumber": "CAPA-0001",
      "title": "Supplier corrective action",
      "status": "OPEN",
      "dueDate": "2026-10-01T00:00:00.000Z"
    }
  ],
  "pagination": { "page": 1, "limit": 10, "total": 1, "totalPages": 1 }
}

Creating and updating records

Connected systems such as your ERP can raise NCRs, complaints and CAPAs directly in the QMS. New records get a reference number, are attributed to the person who created the API key, are written to the tamper-evident audit trail and trigger your automation rules, exactly as if they had been raised in the app.

Writes need an API key with read & write access. Read-only keys receive 403 insufficient_scope.

POST/api/v1/ncrsCreate a new record (ncrs)
PATCH/api/v1/ncrs/{id}Update an open record (ncrs)
POST/api/v1/complaintsCreate a new record (complaints)
PATCH/api/v1/complaints/{id}Update an open record (complaints)
POST/api/v1/capasCreate a new record (capas)
PATCH/api/v1/capas/{id}Update an open record (capas)

Accepted fields

ResourceRequiredOptional
ncrstitle, descriptionseverity (MINOR|MAJOR|CRITICAL), productProcess, detectionDate, capaId, siteId, sourceSystem, externalReference · PATCH: status (OPEN|UNDER_INVESTIGATION|CAPA_RAISED)
complaintstitle, descriptioncustomerName, product, severity (LOW|MEDIUM|HIGH|CRITICAL), assignedToEmail, capaId, siteId, sourceSystem, externalReference · PATCH: status (OPEN|UNDER_INVESTIGATION|RESOLVED), disposition
capastitle, descriptionsource (AUDIT_FINDING|NCR|CUSTOMER_COMPLAINT|INTERNAL_OBSERVATION), sourceReferenceId, dueDate (default +30 days), assignedToEmail, rootCauseMethod (FIVE_WHY|FISHBONE), rootCauseAnalysis, actionPlan, siteId · PATCH: status (OPEN|IN_PROGRESS|PENDING_VERIFICATION)
  • People are matched by email address and must be users in your organisation. Dates use ISO 8601. sourceSystem and externalReference (for example a purchase order or delivery number) are recorded in the audit trail.
  • Send an Idempotency-Key header with each create. If the same key is sent again within 7 days, the original record is returned with replayed: true instead of a duplicate being created.
  • Records cannot be closed over the API, and closed records cannot be changed. Closure stays a reviewed, signed-off step inside the QMS.
  • Invalid input returns 422 validation_error with a details list explaining each problem.

Example: raise an NCR from a failed goods-in inspection

curl -X POST "https://dmg-qms.com/api/v1/ncrs" \
  -H "Authorization: Bearer qms_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: GRN-48812-L3" \
  -d '{
    "title": "Goods-in rejection: housing out of tolerance",
    "description": "12 of 200 units failed dimensional check on GRN-48812.",
    "severity": "MAJOR",
    "productProcess": "Goods-in inspection",
    "sourceSystem": "Orbis ERP",
    "externalReference": "PO-10422 / GRN-48812"
  }'
DMG Quality Management SystemBack to app →