API REFERENCE

SpendSeer API Docs

This page is for people connecting scripts, agents, or custom tools to SpendSeer. The interactive reference below is generated from the live OpenAPI spec served by the app, but you can also just use the example requests if you prefer a simpler starting point.

Use your own tools

Connect curl, Postman, scripts, or AI tools using a personal API token from SpendSeer settings.

Always current

This page reads the live OpenAPI document so endpoint and schema details stay in sync with the app.

Safe first steps

Start with a read-only token, verify your workflow, then add write scopes only if you need them.

App Base URL https://app.spendseer.com

OpenAPI JSON https://app.spendseer.com/api/openapi.json

Authentication

Create a token in the app under Settings → API Tokens. Send it with the standard bearer token header in your requests. You can test with curl first, then use the Authorize button in the interactive reference when you are ready.

Authorization: Bearer <YOUR_API_TOKEN>

Use separate tokens per tool or script so you can rotate or revoke one integration without affecting the rest.

OpenAPI Spec

SpendSeer publishes a machine-readable OpenAPI spec that powers this page. You can use the same URL for code generation, schema validation, or importing into clients like Postman and Insomnia. If you are not using those tools, you can ignore the raw spec and just use the interactive reference or the curl examples below.

Spec URL: https://app.spendseer.com/api/openapi.json
Format: JSON (OpenAPI 3.1)
Server URL is populated from the app's public URL configuration

Interactive Reference

The endpoint list, schemas, and request/response shapes below are rendered directly from the live spec.

API reference loaded from the live OpenAPI spec. Authorize with an API token created in the app to try the interactive table below. Your token is used only to authorize requests and is not saved.

Example Requests

Start with a read-only token so you can confirm your setup without risking accidental changes.

Recommended starting token (UI preset)

In Settings → API Tokens, start with the AI Read-Only (Recommended) preset. It covers the most common reporting and analysis endpoints:

transactions:read
loans:read
goals:read
budgets:read
categories:read

Verify token + workspace context (no capability-specific scope required)

curl "https://app.spendseer.com/api/v1/context" \
  -H "Authorization: Bearer $SPENDSEER_TOKEN"

Read analytics summary (requires: transactions:read, categories:read, budgets:read)

curl "https://app.spendseer.com/api/v1/analytics/summary?start_date=2026-02-01&end_date=2026-02-26" \
  -H "Authorization: Bearer $SPENDSEER_TOKEN"

Interactive docs auth (Swagger UI)

Open the Authorize button in the interactive reference above.
Paste your token value (no Bearer prefix needed).
Run a read-only endpoint first, then add broader token scopes only if a write workflow needs them.

Notes

Use read-only scopes first, then add write scopes only for the actions your automation actually needs.
Store API tokens in your secret manager or local environment variables, not in source code.
The main user docs live at docs.spendseer.com; this page is the API-focused companion guide.