Overview
REST endpoints for every SaaSFlow resource, with parameters, responses, and an interactive playground.
The SaaSFlow API exposes every object you see in the app over REST. Pick a resource:
Companies
Users
Account groups
Accounts
Categories
Customers
Vendors
Counterparties
Transactions
Integrations
Comments
Notifications
Files
Background tasks
Agent definitions
Agent runs
Ai consents
Reports
Categorization suggestions
Plan items
Product groups
Products
Subscriptions
Subscription events
Planned transactions
Planned transaction occurrences
Data
Search
Every endpoint shares the same base URL (https://api.saasflow.com), JSON
payloads, and three authentication modes — see
Authentication. With the exception of
/companies itself, every resource is scoped to a company under
/companies/{companyId}/….
Data slices
Pre-aggregated analytics endpoints — MRR, cash flow, P&L, balances, forecasts.
List companies
List the companies the authenticated caller can reach, with their `role` in each and the effective `permissions`. Start here when you do not have a `companyId`: every other endpoint is scoped to one company. A `permissions` of null means the role preset applies rather than an explicit allowlist. An API key scoped to a single company sees only that one.