DevelopersAPIReferencecustomers
List customers
List customers, sorted by name, each enriched with its transaction count, subscription count, and current committed MRR.
Authentication
Checking whether you're signed in…
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
Length
1 <= lengthQuery Parameters
q?string
limit?integer
Range
1 <= value <= 500offset?|
Range
0 <= valueonlyActive?string
Value in
- "0"
- "1"
- "true"
- "false"
linkedTo?string
Keep only rows linked to an integration: an integration name (e.g. stripe, digistore24) keeps rows carrying an external id from that integration, any keeps rows linked to at least one integration, none keeps rows linked to no integration.
Value in
- "any"
- "none"
- "stripe"
- "slack"
- "hubspot"
- "datevPayroll"
- "finway"
- "pleo"
- "salesforce"
- "digistore24"
- "paypal"
productId?string
Keep only the customers with a subscription that booked an event against this product, which is what the product page links to for its customers.
Format
uuidResponse Body
application/json
curl -X GET "https://example.com/companies/string/customers"null