User Guide Chapter 11

11. Data Export API

The Data Export API gives you secure, read-only access to your Team's data so you can pull it into spreadsheets, internal reporting, or any business tool you choose to connect. It's the clean way to get your numbers out of Open Mind Ledger on your own terms.

  • Generate tokens under Settings → Data Export API (👤 Admin).
  • Full developer reference is published in-app at /docs/api/.

Read-only and yours. The API is GET-only — it can never change your data or your QuickBooks books. You connect whatever tools you prefer on your side; Open Mind Ledger simply hands over your data.


11.1 Generate a token 👤 Admin

  1. Open Settings (/a/<team-slug>/qbo/settings/) and find the Data Export API card.
  2. Click Generate API token.
  3. Copy the token immediately and store it somewhere safe — it's shown once. Treat it like a password.

  4. To rotate or disable access, Revoke the token and generate a new one.

Tokens are scoped to a single Team. A token only ever returns that Team's data.


11.2 Authentication

Send the token as a Bearer token in the Authorization header:

Authorization: Bearer <your-token>

Requests are rate-limited (about 60 requests per minute) to keep things stable. If you exceed the limit, slow down and retry.


11.3 Team endpoints

Base path: /api/v1/team/<team-slug>/

Endpoint Returns
GET /alerts/ The Team's alerts.
GET /alerts/<id>/ A single alert.
GET /kpis/ Current KPIs / key metrics.
GET /rules/ The alert rules configured for the Team.
GET /transactions/recent/ Recent transactions.

Results are paginated. Follow the pagination links in each response to page through large result sets.

Example

curl -H "Authorization: Bearer $OML_TOKEN" \
  https://<your-oml-domain>/api/v1/team/acme-co/kpis/

11.4 Consolidation (group) endpoints

If you use the Consolidation module, group-level statements are also available:

Base path: /api/v1/group/<group-slug>/consolidated/

Endpoint Returns
GET /pnl/ Consolidated profit & loss.
GET /bs/ Consolidated balance sheet.
GET /cash-flow/ Consolidated cash flow.
GET /eliminations/ Intercompany eliminations.
GET /entities/ The entities in the group.

11.5 Schema & docs

  • Human-readable docs: /docs/api/
  • OpenAPI schema: /api/schema/
  • Interactive explorers: /api/schema/swagger-ui/ and /api/schema/redoc/

Use these to see exact field names and response shapes before you build an integration.