SaaSFlow
DevelopersAPIReferencecustomers

List customers

List customers, sorted by name, each enriched with its transaction count, subscription count, and current committed MRR. The response shape depends on `limit`: send it and you get `{ items, totalCount }`, omit it and you get a bare array of every customer. `q` matches on name, and `onlyActive=true` keeps just the customers whose current cMRR is above zero. The enrichment fields are gated separately from customer master data, so a caller without `transactions:read` or `subscriptions:read` gets those keys omitted rather than nulled.

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

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

Query Parameters

q?string
limit?integer
Range1 <= value <= 500
offset?|
Range0 <= value
onlyActive?string

Value in

  • "0"
  • "1"
  • "true"
  • "false"

Response Body

application/json

curl -X GET "https://example.com/companies/string/customers"
null

Reorder

Set the display order of categories. Each id's `order` becomes its position in the array you send, so send the full list rather than the few you moved.

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.