SaaSFlow
DevelopersAPIReferenceproduct_groups

Retrieve product group

Retrieve a single product group by id. Returns 404 if the group 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}/product_groups/{productGroupId}

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

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/product_groups/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "archived": true,  "order": -8388608,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Reorder

Set the display order of product groups. Pass every group id in the order you want them shown; each group's `order` becomes its position in the array. Send the full list, because groups you omit keep their old `order` and can end up interleaved.

Delete product group

Delete a product group. Move every product out of the group first (`PUT /products/{productId}/change_group`), otherwise the delete fails on the foreign key from products. Archive the group with `PUT` if you only want it hidden.