List assignable members
Returns assignable members accessible to the API key’s account.
GET
/api/v1/systems/side-systems/{sideSystemId}/assignable-memberssystems: 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 |
|---|---|---|---|
sideSystemId | string (uuid) | Required | Identifier of the side system. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
name | string | Required | Name of the resource. |
displayName | null | string | Optional | Display name. |
unscoped | boolean | Optional | Unscoped. Member is in main scope and will be linked to the parent side when chosen. Allowed values: false, true. |
currentSubSystemName | null | string | Optional | Current Sub System Name. Current sub system membership label, if any. |
eligible | boolean | Required | Eligible. False when member belongs to a different side system. |
ineligibleReason | null | string | Optional | Ineligible Reason. |
Errors
400· JSON errorMissing side system id.
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/side-systems/11111111-1111-4111-8111-111111111111/assignable-members' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
[
{
"_id": "11111111-1111-4111-8111-111111111111",
"name": "River",
"displayName": null,
"unscoped": false,
"currentSubSystemName": null,
"eligible": false,
"ineligibleReason": null
}
]Example values are illustrative demo data.