Florality

GET

/api/v1/friends/requests

friends: read1,000 requests/minute/key · all plans

Active 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
`id`	`string`	Required	Unique identifier.
`friendUserId`	`string`	Required	Friend User Id.
`status`	`string`	Required	Status. Allowed values: "pending", "accepted", "blocked", "revoked".
`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. Resolved banner for list rows; null if unset or not embeddable.
`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.
`privacyBucketIds`	`array<string>`	Required	Privacy Bucket Ids. Owner-assigned privacy bucket ids for this friend (empty if legacy / not configured).
`friendProfileStyle`	`null \| object`	Required	Friend Profile Style.
`friendProfileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`friendProfileStyle.avatarRing.show`	`boolean`	Optional	Show. Allowed values: false, true.
`friendProfileStyle.avatarRing.colorHex`	`null \| string`	Optional	Color Hex.
`friendProfileStyle.avatarRing.shape`	`string`	Optional	Shape. Allowed values: "moon", "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown".
`friendProfileStyle.avatarRing.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.avatarRing.animation`	`string`	Optional	Animation. Allowed values: "none", "pulse", "rotate", "shimmer".
`friendProfileStyle.avatarRing.animationSpeed`	`number`	Optional	Animation Speed.
`friendProfileStyle.avatarRing.strokeStyle`	`string`	Optional	Stroke Style. Allowed values: "single", "double", "glow".
`friendProfileStyle.avatarRing.customMaskStorageId`	`string`	Optional	Custom Mask Storage Id.
`friendProfileStyle.avatarRing.customMaskPathD`	`string`	Optional	Custom Mask Path D.
`friendProfileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`friendProfileStyle.bannerFrame.colorHex`	`null \| string`	Optional	Color Hex.
`friendProfileStyle.bannerFrame.showBorder`	`boolean`	Optional	Show Border. Allowed values: false, true.
`friendProfileStyle.bannerFrame.borderWidthPx`	`number`	Optional	Border Width Px.
`friendProfileStyle.bannerFrame.borderStyle`	`string`	Optional	Border Style. Allowed values: "none", "double", "solid", "dashed".
`friendProfileStyle.bannerFrame.cornerStyle`	`string`	Optional	Corner Style. Allowed values: "default", "rounded", "sharp".
`friendProfileStyle.memberName`	`object`	Optional	Member Name.
`friendProfileStyle.memberName.fontFamily`	`null \| string`	Optional	Font Family.
`friendProfileStyle.memberName.customFontId`	`null \| string`	Optional	Custom Font Id.
`friendProfileStyle.memberName.colorHex`	`null \| string`	Optional	Color Hex.
`friendProfileStyle.memberName.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.memberName.letterSpacing`	`string`	Optional	Letter Spacing. Allowed values: "normal", "wide".
`friendProfileStyle.memberName.smallCaps`	`boolean`	Optional	Small Caps. Allowed values: false, true.
`friendProfileStyle.memberName.textShadow`	`boolean`	Optional	Text Shadow. Allowed values: false, true.
`friendProfileStyle.memberName.nameEffect`	`string`	Optional	Name Effect. Allowed values: "none", "shimmer", "soft-glow".
`friendProfileStyle.bannerImage`	`object`	Optional	Banner Image.
`friendProfileStyle.bannerImage.brightness`	`number`	Optional	Brightness.
`friendProfileStyle.bannerImage.contrast`	`number`	Optional	Contrast.
`friendProfileStyle.bannerImage.tintHex`	`null \| string`	Optional	Tint Hex.
`friendProfileStyle.bannerImage.tintOpacity`	`number`	Optional	Tint Opacity.
`friendProfileStyle.avatarImage`	`object`	Optional	Avatar Image.
`friendProfileStyle.avatarImage.brightness`	`number`	Optional	Brightness.
`friendProfileStyle.avatarImage.contrast`	`number`	Optional	Contrast.
`friendProfileStyle.avatarImage.tintHex`	`null \| string`	Optional	Tint Hex.
`friendProfileStyle.avatarImage.tintOpacity`	`number`	Optional	Tint Opacity.
`friendProfileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`friendProfileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`friendProfileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`friendProfileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`friendProfileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`friendProfileStyle.profileBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`friendProfileStyle.profileBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.profileBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`friendProfileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`friendProfileStyle.pageBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`friendProfileStyle.pageBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.pageBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`friendProfileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`friendProfileStyle.panelBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`friendProfileStyle.panelBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.panelBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`friendProfileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`friendProfileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`createdAt`	`number`	Required	Creation time.
`acceptedAt`	`null \| number`	Required	Accepted At.

Errors

401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires friends: read; ownership or feature restrictions may also deny access.
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request GET 'https://floralitys.com/api/v1/friends/requests' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

[
  {
    "id": "11111111-1111-4111-8111-111111111111",
    "friendUserId": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "name": "River",
    "username": null,
    "imageUrl": null,
    "friendPronouns": null,
    "friendStatus": null,
    "friendBannerUrl": null,
    "isAdmin": false,
    "planKey": null,
    "donorSupporterUnlocked": false,
    "closedBetaParticipantAt": null,
    "bugBountyUnlockedAt": null,
    "privacyBucketIds": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "friendProfileStyle": null,
    "createdAt": 1767225600000,
    "acceptedAt": null
  }
]

Example values are illustrative demo data.

Response schema

200

Successful response.

Name	Type	Required	Description
`id`	`string`	Required	Unique identifier.
`friendUserId`	`string`	Required	Friend User Id.
`status`	`string`	Required	Status. Allowed values: "pending", "accepted", "blocked", "revoked".
`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. Resolved banner for list rows; null if unset or not embeddable.
`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.
`privacyBucketIds`	`array<string>`	Required	Privacy Bucket Ids. Owner-assigned privacy bucket ids for this friend (empty if legacy / not configured).
`friendProfileStyle`	`null \| object`	Required	Friend Profile Style.
`friendProfileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`friendProfileStyle.avatarRing.show`	`boolean`	Optional	Show. Allowed values: false, true.
`friendProfileStyle.avatarRing.colorHex`	`null \| string`	Optional	Color Hex.
`friendProfileStyle.avatarRing.shape`	`string`	Optional	Shape. Allowed values: "moon", "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown".
`friendProfileStyle.avatarRing.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.avatarRing.animation`	`string`	Optional	Animation. Allowed values: "none", "pulse", "rotate", "shimmer".
`friendProfileStyle.avatarRing.animationSpeed`	`number`	Optional	Animation Speed.
`friendProfileStyle.avatarRing.strokeStyle`	`string`	Optional	Stroke Style. Allowed values: "single", "double", "glow".
`friendProfileStyle.avatarRing.customMaskStorageId`	`string`	Optional	Custom Mask Storage Id.
`friendProfileStyle.avatarRing.customMaskPathD`	`string`	Optional	Custom Mask Path D.
`friendProfileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`friendProfileStyle.bannerFrame.colorHex`	`null \| string`	Optional	Color Hex.
`friendProfileStyle.bannerFrame.showBorder`	`boolean`	Optional	Show Border. Allowed values: false, true.
`friendProfileStyle.bannerFrame.borderWidthPx`	`number`	Optional	Border Width Px.
`friendProfileStyle.bannerFrame.borderStyle`	`string`	Optional	Border Style. Allowed values: "none", "double", "solid", "dashed".
`friendProfileStyle.bannerFrame.cornerStyle`	`string`	Optional	Corner Style. Allowed values: "default", "rounded", "sharp".
`friendProfileStyle.memberName`	`object`	Optional	Member Name.
`friendProfileStyle.memberName.fontFamily`	`null \| string`	Optional	Font Family.
`friendProfileStyle.memberName.customFontId`	`null \| string`	Optional	Custom Font Id.
`friendProfileStyle.memberName.colorHex`	`null \| string`	Optional	Color Hex.
`friendProfileStyle.memberName.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.memberName.letterSpacing`	`string`	Optional	Letter Spacing. Allowed values: "normal", "wide".
`friendProfileStyle.memberName.smallCaps`	`boolean`	Optional	Small Caps. Allowed values: false, true.
`friendProfileStyle.memberName.textShadow`	`boolean`	Optional	Text Shadow. Allowed values: false, true.
`friendProfileStyle.memberName.nameEffect`	`string`	Optional	Name Effect. Allowed values: "none", "shimmer", "soft-glow".
`friendProfileStyle.bannerImage`	`object`	Optional	Banner Image.
`friendProfileStyle.bannerImage.brightness`	`number`	Optional	Brightness.
`friendProfileStyle.bannerImage.contrast`	`number`	Optional	Contrast.
`friendProfileStyle.bannerImage.tintHex`	`null \| string`	Optional	Tint Hex.
`friendProfileStyle.bannerImage.tintOpacity`	`number`	Optional	Tint Opacity.
`friendProfileStyle.avatarImage`	`object`	Optional	Avatar Image.
`friendProfileStyle.avatarImage.brightness`	`number`	Optional	Brightness.
`friendProfileStyle.avatarImage.contrast`	`number`	Optional	Contrast.
`friendProfileStyle.avatarImage.tintHex`	`null \| string`	Optional	Tint Hex.
`friendProfileStyle.avatarImage.tintOpacity`	`number`	Optional	Tint Opacity.
`friendProfileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`friendProfileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`friendProfileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`friendProfileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`friendProfileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`friendProfileStyle.profileBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`friendProfileStyle.profileBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.profileBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`friendProfileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`friendProfileStyle.pageBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`friendProfileStyle.pageBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.pageBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`friendProfileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`friendProfileStyle.panelBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`friendProfileStyle.panelBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`friendProfileStyle.panelBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`friendProfileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`friendProfileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`createdAt`	`number`	Required	Creation time.
`acceptedAt`	`null \| number`	Required	Accepted At.

Responses

Successful response.

JSON

[
  {
    "id": "11111111-1111-4111-8111-111111111111",
    "friendUserId": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "name": "River",
    "username": null,
    "imageUrl": null,
    "friendPronouns": null,
    "friendStatus": null,
    "friendBannerUrl": null,
    "isAdmin": false,
    "planKey": null,
    "donorSupporterUnlocked": false,
    "closedBetaParticipantAt": null,
    "bugBountyUnlockedAt": null,
    "privacyBucketIds": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "friendProfileStyle": null,
    "createdAt": 1767225600000,
    "acceptedAt": null
  }
]

Example values are illustrative demo data.

List friend requests

Parameters

Response schema

200

Errors

Request example

Responses

List friend requests

Parameters

Response schema

200

Errors

Request example

Responses