SaaSFlow
DevelopersAPIReferenceproducts

Retrieve product

Retrieve a single product by id. Unlike the list endpoint, this returns the plain product without the cMRR and event-count enrichment.

Authentication

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

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
productId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/products/string"
{  "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"  ]}

Reorder

Reorder products inside one group, and move them into it in the same call. Every id in productIds is assigned to productGroupId (send null for the…

Delete product

Delete a product. Check eventCount on the list endpoint first: a product still referenced by subscription events is load-bearing for MRR-by-product…