SaaSFlow
DevelopersAPIReferencecustomers

Retrieve customer

Retrieve a single customer by id. Returns 404 if the customer does not exist or belongs to another company.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
GET
/companies/{companyId}/customers/{customerId}

Authorization

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.

In: header

Path Parameters

companyId*string
Length1 <= length
customerId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/customers/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "defaultCategorization": {    "categoryId": "string",    "usingDateRule": {      "type": "transactionDate"    },    "plSplit": {      "revenue": 0,      "cogs": 0,      "cac": 0,      "pd": 0,      "ga": 0,      "no": 0,      "neutral": 0    },    "passThroughTax": 0,    "transferTargetAccountId": "string"  },  "domains": [    "string"  ],  "logo": true,  "autoCreatedSource": "searchApiGoogleWebSearch",  "countryCode": "string",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string",  "externalIds": [    "string"  ]}

Create customer

Create a customer. `domains` are the email or web domains used to match incoming payments to this customer automatically. `defaultCategorization` is the template applied to transactions attributed to them, so setting it once saves categorizing every future payment by hand. `countryCode` is ISO 3166-1 alpha-2.

Delete customer

Delete a customer. This reaches further than it looks: their subscriptions are cascade-deleted, which changes MRR history, and any planned transaction pointing at them is unassigned. Transactions survive but lose their counterparty, and each one is flagged to stay out of auto-categorization so the deleted customer is not immediately re-matched. For a duplicate record, merge instead of deleting.