List systems
Returns systems accessible to the API key’s account.
GET
/api/v1/systemssystems: 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
No path or query parameters.
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
active | object | Required | Active. |
active.sideSystemId | string | Required | Side System Id. |
active.subSystemId | null | string | Optional | Sub System Id. |
active.isUnifiedView | boolean | Optional | Is Unified View. Allowed values: false, true. |
active.updatedAt | number | Required | Most recent update time. |
sideSystems | array<object> | Required | Side Systems. |
sideSystems[]._id | string | Required | Unique identifier. |
sideSystems[].userId | string | Required | Owning account identifier. |
sideSystems[].name | string | Required | Name of the resource. |
sideSystems[].description | string | Optional | Description of the resource. |
sideSystems[].icon | string | Optional | Icon. |
sideSystems[].tagCode | string | Optional | Tag Code. |
sideSystems[].tagColor | string | Optional | Tag Color. |
sideSystems[].memberCount | number | Optional | Member Count. Active members on this side, including those in a nested sub. |
sideSystems[].createdAt | number | Required | Creation time. |
sideSystems[].updatedAt | number | Required | Most recent update time. |
subSystems | array<object> | Required | Sub Systems. |
subSystems[]._id | string | Required | Unique identifier. |
subSystems[].userId | string | Required | Owning account identifier. |
subSystems[].sideSystemId | string | Required | Side System Id. |
subSystems[].parentSubSystemId | null | string | Optional | Parent Sub System Id. |
subSystems[].linkedMemberId | null | string | Optional | Linked Member Id. |
subSystems[].name | string | Required | Name of the resource. |
subSystems[].description | string | Optional | Description of the resource. |
subSystems[].icon | string | Optional | Icon. |
subSystems[].tagCode | string | Optional | Tag Code. |
subSystems[].tagColor | string | Optional | Tag Color. |
subSystems[].createdAt | number | Required | Creation time. |
subSystems[].updatedAt | number | Required | Most recent update time. |
Errors
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires systems: 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/systems' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"active": {
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"subSystemId": null,
"isUnifiedView": false,
"updatedAt": 1767225600000
},
"sideSystems": [
{
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"name": "River",
"description": "A note from our demo system.",
"icon": "demo",
"tagCode": "demo",
"tagColor": "#70846b",
"memberCount": 0,
"createdAt": 1767225600000,
"updatedAt": 1767225600000
}
],
"subSystems": [
{
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"parentSubSystemId": null,
"linkedMemberId": null,
"name": "River",
"description": "A note from our demo system.",
"icon": "demo",
"tagCode": "demo",
"tagColor": "#70846b",
"createdAt": 1767225600000,
"updatedAt": 1767225600000
}
]
}Example values are illustrative demo data.