SaaSFlow
DevelopersAPIReferenceaccount_groups

Retrieve account group

Retrieve a single account 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}/account_groups/{accountGroupId}

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

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/account_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 account groups. Pass every group id in the order you want them shown; each group's `order` is set to its position in the array. Groups you leave out of the array keep their current `order` and may end up interleaved, so send the full list.

Delete account group

Delete an account group. Move every account out of the group first (`PUT /accounts/{accountId}/change_group`), otherwise the delete fails on the foreign key from accounts. To keep the grouping but hide it, archive the group with `PUT` instead.