SaaSFlow
DevelopersAPIReferenceproducts

List products

List a company's products, each with subscriptionCount (how many subscriptions have booked at least one event against it), activeSubscriptionCount (how…

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/products

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.

Path Parameters

companyId*string
Length1 <= length

Query Parameters

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"

Response Body

List of products with CMRR and usage data

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/companies/string/products"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "name": "string",    "nameManuallyEdited": true,    "productGroupId": "c416ccc2-c7d5-4733-9136-58a3b93937ed",    "order": -8388608,    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string",    "externalIds": [      "string"    ],    "subscriptionCount": 0,    "activeSubscriptionCount": 0,    "eventCount": 0,    "cmrrByCurrency": {      "property1": 0,      "property2": 0    },    "activeMrrRangeByCurrency": {      "property1": {        "min": 0,        "max": 0      },      "property2": {        "min": 0,        "max": 0      }    }  }]