Skip to Content
SaaSFlow
DevelopersAPIReferenceplan_items

List plan items

List every plan item for a company. A plan item is one budgeted line in the financial plan: a P&L type, a category, a starting month (YYYY-MM), and an…

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/plan_items

Authorization

headerAuthorization<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.

Path Parameters

companyId*string
Formatuuid

Response Body

List of plan items

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/plan_items'
Example Response200
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "month": "string",    "plType": "revenue",    "categoryId": "string",    "amount": {      "type": "fixed",      "amount": {        "value": 0,        "currency": "EUR"      },      "relativeChange": 0    },    "duration": -2147483648,    "frequency": -2147483648,    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string"  }]