A read-only REST API for every DPO account: pull companies, compliance scores, tickets, breaches, ROPA and DPIA records into your own reporting, dashboards or client portals.
Generate a personal API key from Account → API once you're signed in, no OAuth dance, just a bearer token.
Every endpoint is scoped to companies your account manages. Your key can never see another DPO's data.
Every response is JSON over HTTPS. No SDK required: curl, a browser, or any HTTP client works.
Send your key in an Authorization header (or X-API-Key) on every request:
Get a key: create a free account, then generate one from Account → API once logged in. Keys are shown once at creation and stored hashed. If you lose one, revoke it and generate a new one.
Every successful response is a JSON object with a single data key — an object for a single-record endpoint like compliance.php, or an array for a list endpoint like tickets.php. There's no pagination: list endpoints return everything that matches (a DPO's own company/record counts are small enough that this stays fast). Dates are returned exactly as stored, in Africa/Harare, as YYYY-MM-DD HH:MM:SS (or null when the event hasn't happened yet, e.g. resolved_at on an open ticket).
The API is deliberately read-only (GET only, everything else gets a 405) — it's built for pulling data into dashboards, spreadsheets and reporting tools, not for writing back into the platform.
GET /companies.phpEvery company the authenticated DPO manages, with its current overall compliance percentage. This is the endpoint most integrations start with — use the id from each entry as the company_id for every other endpoint below.
Params: none.
Response — data is an array of:
compliance_percent is the same weighted overall score shown on that company's dashboard — see compliance.php below for the per-module breakdown behind it. A brand-new company with nothing recorded yet in any module shows 0 rather than an inflated score.
GET /compliance.phpThe full compliance breakdown for one company: every module's individual score, its configured weight, and how much it contributes to the overall percentage — the same numbers that drive the compliance chart inside the app.
Params: company_id (required) — from companies.php.
Response — modules has one entry per compliance module (keyed by module id: licensing, policies, breaches, tickets, dpia, ropa, training, audits, vendors):
weight reflects that company's current compliance weight settings (a platform default unless the DPO has customised them), and score/contribution are each rounded to one decimal place.
GET /tickets.phpData subject support tickets (access, deletion, correction and similar requests) logged for one company, newest first.
Params: company_id (required). status (optional) — one of Open, In Progress, Resolved, Rejected; any other value is ignored and all statuses are returned.
Response — data is an array of:
GET /breaches.phpData breach incidents logged for one company, newest first.
Params: company_id (required). status (optional) — one of Open, Investigating, Contained, Closed; any other value is ignored and all statuses are returned.
Response — data is an array of:
GET /ropa.phpRecords of Processing Activities for one company. ROPA's field set is customisable per company (see Vendor/ROPA field customisation inside the app), so every entry carries both its data (the actual answers, keyed by field key) and a fields array describing what each key means — don't hard-code field keys in your integration, read them from fields.
Params: company_id (required).
Response — data is an array of:
GET /dpia.phpData Protection Impact Assessments for one company. Works the same way as ropa.php: read field metadata from fields rather than assuming keys. Each field also carries a type (e.g. text, textarea, table) and an optional section heading. For a table-type field, its value inside data is an array of row objects instead of a scalar.
Params: company_id (required).
Response — data is an array of:
A failed request returns a matching HTTP status code and a JSON body of the form {"error": "..."} instead of data:
| Status | Meaning |
|---|---|
400 | A required parameter is missing or not a valid integer — e.g. company_id left out or non-numeric. |
401 | No API key was sent, or the key is invalid, revoked, or belongs to a DPO account that's no longer active. |
404 | The company_id doesn't exist, or exists but belongs to a different DPO account — the API never distinguishes the two, so another account's data can't be probed for. |
405 | Anything other than GET was used. The API is read-only. |
Every key you generate is scoped to your own account only — even a leaked key can't be used to read another DPO's companies, and revoking a key from Account → API takes effect immediately on the next request.