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…
Authentication
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.
companyId*string1 <= lengthCompany details with users
application/json- response
id*stringuuidfirestoreId*string|nullname*stringThe name of the company.
baseCurrency*stringThe base currency for the company.
"EUR""AUD""BRL""CAD""CHF""CNY""CZK""DKK""GBP""HKD""HUF""IDR""ILS""INR""ISK""JPY""KRW""MXN""MYR""NOK""NZD""PHP""PLN""RON""SEK""SGD""THB""TRY""USD""ZAR"domain*|The company's website domain, such as example.com. Null when not set.
customLogoPath*|Path of the logo uploaded in the company settings, relative to the public assets host. Null when the company shows the logo of its website domain.
lastOverallUpdatedTime*stringWhen any data within the company was last updated.
date-timeplShowPlanningPercentageForPastMonths*booleanWhether to show planning percentages for past months in P&L.
plShowAllCategories*booleanWhether to show all categories in P&L, including empty ones.
plRecognizeRevenueOnInvoice*booleandataStartDate*|The company-wide data start date. Imports skip transactions dated before it. Null means no start date is set.
valuationCategory*|Self-declared company category used by the valuation estimate. Null means traditional B2B SaaS.
"traditional""aiEnhanced""aiNative"nullvaluationLens*|Which comparable set the valuation estimate prices against. Null means fundraising.
"fundraising""acquisition"nullsystemStatus*stringThe status of the company.
"sandbox""trial""free""paid""cancelled""expired""beta"systemTrialUntil*|date-timesystemExpiredAt*|date-timesystemDeletionWarning*|-2147483648 <= value <= 2147483647systemSandboxExpireTime*|date-timesystemDeletionScheduledTime*|date-timesystemStripe?|nullsystemTierOverageSince*|date-timecomputedCommittedMrrEur*string|nullcomputedActiveCustomerCount*|-2147483648 <= value <= 2147483647computedMetricsTime*|date-timecreatedTime*|date-timecreatedUserId*string|nulllastUpdatedTime*|date-timelastUpdatedUserId*string|nullusers*array<>integrationTypes*array<>Distinct integration types currently active for this company. Used by the UI to gate features that depend on a specific integration being installed (e.g. show DATEV personnel-number input only when a datevPayroll integration exists). Avoids loading the full /integrations list — that endpoint is owner-only.
curl -X GET "https://example.com/companies/string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firestoreId": "string", "name": "string", "baseCurrency": "EUR", "domain": "string", "customLogoPath": "string", "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", "users": [ { "id": "string", "userId": "string", "firebaseUserId": "string", "email": "string", "name": "string", "photoURL": "string", "role": "owner", "permissions": [ "subscriptions:read" ], "lastSeenTime": "2019-08-24T14:15:22Z" } ], "integrationTypes": [ "stripe" ]}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…
Update company
Update company settings. Only the fields you send change. Changing baseCurrency restates every converted figure in the app, including historical ones, so…