Categories API
The Categories API returns transaction data aggregated by category. Categories have no separate model in the database — they are just a field on the transaction object — so this endpoint is read-only. To change a category, edit the category field on the affected transactions (see Transactions API).
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/categories | List categories with period aggregates |
Permissions
Requires the reports:read permission — categories are analytics (aggregations), not an editable resource. This permission is included in the full_access and read_only permission presets.
Category Detail
There is no separate "get one category" endpoint. To see the transactions behind a category (and recompute its own totals), filter transactions directly:
GET /api/v1/transactions?category=<name>
Related
- Entities API — the same aggregation, grouped by
entity - Transactions API — edit the
categoryfield - Reports API — time-bucketed analytics