Skip to Content
SaaSFlow
DevelopersAPIReferencecompanies

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…

Authentication

Checking whether you're signed in…
GET
/companies

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.

Response Body

List of companies the user has access to

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.saasflow.com/companies'
Example Response200
[  {    "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        },        "failedPayment": {          "amountDue": 0,          "currency": "string",          "nextPaymentAttempt": "string"        }      },      "endedSubscription": {        "id": "string",        "endedAt": "string",        "reason": "string",        "failedPayment": {          "amountDue": 0,          "currency": "string",          "nextPaymentAttempt": "string"        }      }    },    "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",    "role": "owner",    "permissions": [      "subscriptions:read"    ]  }]