Update company
Update company settings. Only the fields you send change. Changing baseCurrency restates every converted figure in the app, including historical ones, so…
Authentication
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
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/companies/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firestoreId": "string", "name": "string", "baseCurrency": "EUR", "lastOverallUpdatedTime": "2019-08-24T14:15:22Z", "plShowPlanningPercentageForPastMonths": true, "plShowAllCategories": true, "plRecognizeRevenueOnInvoice": true, "dataStartDate": "string", "valuationCategory": "traditional", "valuationLens": "fundraising", "systemStatus": "sandbox", "systemTrialUntil": "2019-08-24T14:15:22Z", "systemExpiredAt": "2019-08-24T14:15:22Z", "systemDeletionWarning": -2147483648, "systemSandboxExpireTime": "2019-08-24T14:15:22Z", "systemDeletionScheduledTime": "2019-08-24T14:15:22Z", "systemStripe": { "customerId": "string", "subscription": { "id": "string", "status": "active", "productName": "starter", "interval": "monthly", "currentPeriodStart": "string", "currentPeriodEnd": "string", "price": { "value": 0, "currency": "string" }, "cancelAt": "string", "limits": { "minARR": 0, "maxARR": 0 } } }, "systemTierOverageSince": "2019-08-24T14:15:22Z", "computedCommittedMrrEur": "string", "computedActiveCustomerCount": -2147483648, "computedMetricsTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string"}Retrieve company
Retrieve one company with its settings and its member list. baseCurrency is the currency every cross-currency figure is converted into, so read it before…
List users
List the people with an actual membership in a company, with their role and when they were last seen. id and userId both carry the SaaSFlow user id, which…