Documentation

Open Mind Ledger Data Export API

Version 1.0

Overview

The Open Mind Ledger Data Export API is a read-only, authenticated interface that returns your team's structured financial data and rule-based alerts in a standard JSON format. It is designed for general-purpose integration with the business tools your team already uses — spreadsheets, internal reporting systems, data warehouses, audit workflows, and any other software that can consume an authenticated REST API.

Returns

What the API returns

Active and historical rule-based alerts, including the rule that fired, severity, a short templated message, and a structured snapshot of the underlying values that triggered the rule.
Current KPI values for your team's financial dashboards.
The set of rules currently configured for your team.
Recent transaction summaries.

Scope

What the API does not do

The Data Export API does not generate narrative explanations, recommendations, or analyses. It returns the underlying structured data and the rule-based outputs of the Service. Any further interpretation is the responsibility of the consuming system.

Authentication

All requests require a team-scoped API token transmitted in the Authorization header. Tokens are generated on the team settings page by team administrators.

Authorization: Bearer <your-token>

Endpoints

Method	Path	Description
GET	/api/v1/team/<slug>/alerts/	List alerts for the team.
GET	/api/v1/team/<slug>/alerts/<id>/	Retrieve a single alert.
GET	/api/v1/team/<slug>/kpis/	List current KPI values.
GET	/api/v1/team/<slug>/rules/	List rules configured for the team.
GET	/api/v1/team/<slug>/transactions/recent/	List recent transaction summaries.

Parameters

Query parameters

Alerts

status — Filter by status: active, resolved, or all (default: all).
since — ISO 8601 datetime; returns only alerts fired at or after this time.

Transactions

days — Number of days to look back (default: 30, max: 365).

Rate Limits

Rate limiting

Requests are limited to 60 per minute per token. Exceeded requests receive HTTP 429. Retry after the interval specified in the Retry-After response header.

Pagination

List endpoints return paginated responses with count, next, previous, and results fields. Default page size is 50 items.

Token Management

Token management

Team administrators can generate and revoke tokens on the team settings page. Each team has one active token at a time. Generating a new token immediately replaces the previous one.