List friend groups tree
Returns friend groups tree accessible to the API key’s account.
GET
/api/v1/friends/{friendUserId}/groupsfriends: read1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
friendUserId | string (uuid) | Required | Identifier of the friend user. |
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
400· JSON errorMissing friend user id.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires friends: read; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorRequest failed (CONFLICT).
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/friends/11111111-1111-4111-8111-111111111111/groups' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
nullExample values are illustrative demo data.