SaaSFlow
DevelopersAPIReferencecategories

List categories

List a company's transaction categories. Each category declares the P&L lines it can post to through `plTypes` (revenue, cogs, cac, pd, ga, no, neutral), which is what lets one category split across the P&L. `used` counts everything currently assigned to the category, both transactions and planned transactions, so a zero there means the category can be deleted outright; `usedTransactions` and `usedPlannedTransactions` break that total down. Categories flagged `system` are created and maintained by SaaSFlow and cannot be deleted at all.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
GET
/companies/{companyId}/categories

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/companies/string/categories"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "name": "string",    "emoji": "string",    "plTypes": [      "revenue"    ],    "system": true,    "systemKey": "string",    "order": -8388608,    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string",    "used": 0,    "usedTransactions": 0,    "usedPlannedTransactions": 0  }]