Get group layout
Returns group layout for the authorised account.
GET
/api/v1/groups/{groupId}/layoutgroupLayout: 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 |
|---|---|---|---|
groupId | string (uuid) | Required | Identifier of the group. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
position | number | Required | Position. |
type | string | Required | Type. Allowed values: "member", "folder", "separator". |
folderId | string | Optional | Folder Id. |
memberId | string | Optional | Associated member identifier. |
separatorLabel | string | Optional | Separator Label. |
separatorColorPreset | string | Optional | Separator Color Preset. |
separatorIcon | string | Optional | Separator Icon. |
deletedAt | null | number | Optional | Deletion time; null when active. |
purgeAt | null | number | Optional | Purge At. |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires groupLayout: 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.
503· JSON errorPostgreSQL is not configured (DATABASE_URL).
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request GET 'https://floralitys.com/api/v1/groups/11111111-1111-4111-8111-111111111111/layout' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
[
{
"_id": "11111111-1111-4111-8111-111111111111",
"position": 0,
"type": "member",
"folderId": "11111111-1111-4111-8111-111111111111",
"memberId": "11111111-1111-4111-8111-111111111111",
"separatorLabel": "demo",
"separatorColorPreset": "#70846b",
"separatorIcon": "demo"
}
]Example values are illustrative demo data.