List friend suggestions
Returns friend suggestions accessible to the API key’s account.
GET
/api/v1/friends/suggestionsfriends: 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
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | Optional | Filter or option: limit. Minimum: 1. Maximum: 50. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
friendUserId | string | Required | Friend User Id. |
mutualFriendCount | number | Required | Mutual Friend Count. |
name | string | Required | Name of the resource. |
username | null | string | Required | Username. |
imageUrl | null | string | Required | Image Url. |
friendPronouns | null | string | Required | Friend Pronouns. |
friendStatus | null | string | Required | Friend Status. |
friendBannerUrl | null | string | Required | Friend Banner Url. |
isAdmin | boolean | Required | Is Admin. |
planKey | null | string | Required | Plan Key. |
donorSupporterUnlocked | boolean | Required | Donor Supporter Unlocked. |
closedBetaParticipantAt | null | number | Required | Closed Beta Participant At. |
bugBountyUnlockedAt | null | number | Required | Bug Bounty Unlocked At. |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires friends: 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/friends/suggestions' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
[
{
"friendUserId": "11111111-1111-4111-8111-111111111111",
"mutualFriendCount": 0,
"name": "River",
"username": null,
"imageUrl": null,
"friendPronouns": null,
"friendStatus": null,
"friendBannerUrl": null,
"isAdmin": false,
"planKey": null,
"donorSupporterUnlocked": false,
"closedBetaParticipantAt": null,
"bugBountyUnlockedAt": null
}
]Example values are illustrative demo data.