SaaSFlow
DevelopersAPIReferencecompanies

Create company

Create a company for the person you act for, with them as its owner. A regular company (type owned, the default) starts a 14-day trial.

Authentication

Checking whether you're signed in…
POST
/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.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 200
baseCurrency*string

The currency every report is converted into. Pick the one the company does its books in.

Value in"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, used for its logo. Dropped if it is not a domain.

type?string

owned is a real company on a 14-day trial. sandbox is a test company without a trial, deleted automatically after 14 days.

Default"owned"
Value in"owned""sandbox"
addSampleData?boolean

Fill the sandbox with sample accounts, customers, subscriptions, transactions and planned transactions. Only for type sandbox.

Defaultfalse

Response Body

The company this connection created with that name moments ago

application/json
  1. response
id*string
url*string
created*false
Value infalse
Example Request
curl -X POST 'https://api.saasflow.com/companies' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "baseCurrency": "EUR"}'
Example Response
{  "id": "string",  "url": "string",  "created": false}

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…

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…