List groups
Returns groups accessible to the API key’s account.
GET
/api/v1/groupsgroups: 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
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
sideSystemId | string (uuid) | Optional | Filter or option: side system id. |
subSystemId | string | null | Optional | Filter or option: sub system id. Default: null. |
include_archived | string | Optional | Only the exact string true includes archived groups. Ignored when explicit system-scope parameters select the tenant-list branch. Default: "false". |
Behaviour and pagination
sideSystemId and subSystemId may be omitted to use the active system scope. If subSystemId is supplied, sideSystemId is required. An empty subSystemId selects no sub-system.
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. |
colorPreset | string | Optional | Color Preset. |
createdAt | number | Optional | Creation time. |
updatedAt | number | Optional | Most recent update time. |
memberCount | number | Optional | Member Count. |
parentId | string | Optional | Parent resource identifier. |
iconColorPreset | string | Optional | Icon Color Preset. |
version | number | Optional | Version used for optimistic concurrency checks. |
sideSystemId | string | Optional | Side System Id. |
subSystemId | string | Optional | Sub System Id. |
deletedAt | number | Optional | Deletion time; null when active. |
purgeAt | number | Optional | Purge At. |
originalParentId | string | Optional | Original Parent Id. |
archivedAt | number | Optional | Archiving time; null when active. |
userId | string | Optional | Owning account identifier. |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
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.
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' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
[
{
"parentId": "11111111-1111-4111-8111-111111111111",
"icon": "demo",
"iconColorPreset": "#70846b",
"createdAt": 1767225600000,
"updatedAt": 1767225600000,
"version": 0,
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"subSystemId": "11111111-1111-4111-8111-111111111111",
"originalParentId": "11111111-1111-4111-8111-111111111111",
"description": "A note from our demo system.",
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"name": "River"
}
]Example values are illustrative demo data.