Group tree
Returns group tree for the authorised account.
GET
/api/v1/groups/treegroups: readdirectories: read1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Groups and directories
The higher access level of
groups and directories is used. Either scope can satisfy this requirement; both are not required. read_write includes read access.Parameters
No path or query parameters.
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier. |
name | string | Required | Name of the resource. |
description | string | Optional | Description of the resource. |
icon | string | Optional | Icon. |
iconColorPreset | string | Optional | Icon Color Preset. |
children | array<object> | Required | Children. |
memberCount | number | Required | Member Count. |
Errors
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires groups or directories: read; ownership or feature restrictions may also deny access.
404· JSON errorRoot group not found.
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request GET 'https://floralitys.com/api/v1/groups/tree' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "River",
"description": "A note from our demo system.",
"icon": "demo",
"iconColorPreset": "#70846b",
"children": [
{}
],
"memberCount": 0
}Example values are illustrative demo data.