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

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

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

Response Body

Account group details

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
name*string

The name of the account group.

archived*boolean

Flag indicating if the account group is archived.

order*number

A number used for ordering account groups in the UI.

Range-8388608 <= value <= 8388607
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
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.

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…