Florality

GET

/api/v1/messaging/preferences/chat-as-members

messaging: 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.

Message storage

Message text is encrypted at rest and decrypted for authorised requests. Channel access is restricted to spaces owned by the API key’s account; missing or inaccessible channels return 404. Editing or deleting a message additionally checks its author and can return 403.

Parameters

No path or query parameters.

Response schema

200

Successful response.

Name	Type	Required	Description
`_id`	`string`	Required	Unique identifier.
`userId`	`string`	Required	Owning account identifier.
`directoryId`	`string`	Required	Containing folder identifier.
`sideSystemId`	`string`	Optional	Side System Id.
`subSystemId`	`string`	Optional	Sub System Id.
`name`	`string`	Required	Name of the resource.
`displayName`	`string`	Optional	Display name.
`pronouns`	`string`	Optional	Member pronouns.
`avatar`	`string`	Optional	Avatar storage reference.
`background`	`string`	Optional	Background storage reference.
`updatedAt`	`number`	Optional	Most recent update time.
`profileStyle`	`null \| object`	Required	Profile presentation settings.
`profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`profileStyle.avatarRing.show`	`boolean`	Optional	Show. Allowed values: false, true.
`profileStyle.avatarRing.colorHex`	`null \| string`	Optional	Color Hex.
`profileStyle.avatarRing.shape`	`string`	Optional	Shape. Allowed values: "moon", "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown".
`profileStyle.avatarRing.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.avatarRing.animation`	`string`	Optional	Animation. Allowed values: "none", "pulse", "rotate", "shimmer".
`profileStyle.avatarRing.animationSpeed`	`number`	Optional	Animation Speed.
`profileStyle.avatarRing.strokeStyle`	`string`	Optional	Stroke Style. Allowed values: "single", "double", "glow".
`profileStyle.avatarRing.customMaskStorageId`	`string`	Optional	Custom Mask Storage Id.
`profileStyle.avatarRing.customMaskPathD`	`string`	Optional	Custom Mask Path D.
`profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`profileStyle.bannerFrame.colorHex`	`null \| string`	Optional	Color Hex.
`profileStyle.bannerFrame.showBorder`	`boolean`	Optional	Show Border. Allowed values: false, true.
`profileStyle.bannerFrame.borderWidthPx`	`number`	Optional	Border Width Px.
`profileStyle.bannerFrame.borderStyle`	`string`	Optional	Border Style. Allowed values: "none", "double", "solid", "dashed".
`profileStyle.bannerFrame.cornerStyle`	`string`	Optional	Corner Style. Allowed values: "default", "rounded", "sharp".
`profileStyle.memberName`	`object`	Optional	Member Name.
`profileStyle.memberName.fontFamily`	`null \| string`	Optional	Font Family.
`profileStyle.memberName.customFontId`	`null \| string`	Optional	Custom Font Id.
`profileStyle.memberName.colorHex`	`null \| string`	Optional	Color Hex.
`profileStyle.memberName.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.memberName.letterSpacing`	`string`	Optional	Letter Spacing. Allowed values: "normal", "wide".
`profileStyle.memberName.smallCaps`	`boolean`	Optional	Small Caps. Allowed values: false, true.
`profileStyle.memberName.textShadow`	`boolean`	Optional	Text Shadow. Allowed values: false, true.
`profileStyle.memberName.nameEffect`	`string`	Optional	Name Effect. Allowed values: "none", "shimmer", "soft-glow".
`profileStyle.bannerImage`	`object`	Optional	Banner Image.
`profileStyle.bannerImage.brightness`	`number`	Optional	Brightness.
`profileStyle.bannerImage.contrast`	`number`	Optional	Contrast.
`profileStyle.bannerImage.tintHex`	`null \| string`	Optional	Tint Hex.
`profileStyle.bannerImage.tintOpacity`	`number`	Optional	Tint Opacity.
`profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`profileStyle.avatarImage.brightness`	`number`	Optional	Brightness.
`profileStyle.avatarImage.contrast`	`number`	Optional	Contrast.
`profileStyle.avatarImage.tintHex`	`null \| string`	Optional	Tint Hex.
`profileStyle.avatarImage.tintOpacity`	`number`	Optional	Tint Opacity.
`profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`profileStyle.profileBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`profileStyle.profileBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.profileBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`profileStyle.pageBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`profileStyle.pageBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.pageBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`profileStyle.panelBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`profileStyle.panelBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.panelBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`backgroundUrl`	`null \| string`	Required	Resolved background URL, or null when unavailable.
`archivedAt`	`number`	Optional	Archiving time; null when active. Set on archived list rows (`members.listArchivedPage`).

Errors

400 · JSON error: Request failed (BAD_REQUEST).
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires messaging: read; ownership or feature restrictions may also deny access.
404 · JSON error: Request failed (NOT_FOUND).
409 · JSON error: conflict.
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.
500 · JSON error: internal server error.
503 · JSON error: Object storage is not configured. Set MinIO (or compatible S3) env vars to upload files.

Request example

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

Shell

curl --request GET 'https://floralitys.com/api/v1/messaging/preferences/chat-as-members' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

[
  {
    "_id": "11111111-1111-4111-8111-111111111111",
    "userId": "11111111-1111-4111-8111-111111111111",
    "directoryId": "11111111-1111-4111-8111-111111111111",
    "sideSystemId": "11111111-1111-4111-8111-111111111111",
    "subSystemId": "11111111-1111-4111-8111-111111111111",
    "name": "River",
    "displayName": "River",
    "pronouns": "they/them",
    "avatar": "demo",
    "background": "demo",
    "updatedAt": 1767225600000,
    "profileStyle": null,
    "avatarUrl": null,
    "backgroundUrl": null
  }
]

Example values are illustrative demo data.

Response schema

200

Successful response.

Name	Type	Required	Description
`_id`	`string`	Required	Unique identifier.
`userId`	`string`	Required	Owning account identifier.
`directoryId`	`string`	Required	Containing folder identifier.
`sideSystemId`	`string`	Optional	Side System Id.
`subSystemId`	`string`	Optional	Sub System Id.
`name`	`string`	Required	Name of the resource.
`displayName`	`string`	Optional	Display name.
`pronouns`	`string`	Optional	Member pronouns.
`avatar`	`string`	Optional	Avatar storage reference.
`background`	`string`	Optional	Background storage reference.
`updatedAt`	`number`	Optional	Most recent update time.
`profileStyle`	`null \| object`	Required	Profile presentation settings.
`profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`profileStyle.avatarRing.show`	`boolean`	Optional	Show. Allowed values: false, true.
`profileStyle.avatarRing.colorHex`	`null \| string`	Optional	Color Hex.
`profileStyle.avatarRing.shape`	`string`	Optional	Shape. Allowed values: "moon", "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown".
`profileStyle.avatarRing.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.avatarRing.animation`	`string`	Optional	Animation. Allowed values: "none", "pulse", "rotate", "shimmer".
`profileStyle.avatarRing.animationSpeed`	`number`	Optional	Animation Speed.
`profileStyle.avatarRing.strokeStyle`	`string`	Optional	Stroke Style. Allowed values: "single", "double", "glow".
`profileStyle.avatarRing.customMaskStorageId`	`string`	Optional	Custom Mask Storage Id.
`profileStyle.avatarRing.customMaskPathD`	`string`	Optional	Custom Mask Path D.
`profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`profileStyle.bannerFrame.colorHex`	`null \| string`	Optional	Color Hex.
`profileStyle.bannerFrame.showBorder`	`boolean`	Optional	Show Border. Allowed values: false, true.
`profileStyle.bannerFrame.borderWidthPx`	`number`	Optional	Border Width Px.
`profileStyle.bannerFrame.borderStyle`	`string`	Optional	Border Style. Allowed values: "none", "double", "solid", "dashed".
`profileStyle.bannerFrame.cornerStyle`	`string`	Optional	Corner Style. Allowed values: "default", "rounded", "sharp".
`profileStyle.memberName`	`object`	Optional	Member Name.
`profileStyle.memberName.fontFamily`	`null \| string`	Optional	Font Family.
`profileStyle.memberName.customFontId`	`null \| string`	Optional	Custom Font Id.
`profileStyle.memberName.colorHex`	`null \| string`	Optional	Color Hex.
`profileStyle.memberName.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.memberName.letterSpacing`	`string`	Optional	Letter Spacing. Allowed values: "normal", "wide".
`profileStyle.memberName.smallCaps`	`boolean`	Optional	Small Caps. Allowed values: false, true.
`profileStyle.memberName.textShadow`	`boolean`	Optional	Text Shadow. Allowed values: false, true.
`profileStyle.memberName.nameEffect`	`string`	Optional	Name Effect. Allowed values: "none", "shimmer", "soft-glow".
`profileStyle.bannerImage`	`object`	Optional	Banner Image.
`profileStyle.bannerImage.brightness`	`number`	Optional	Brightness.
`profileStyle.bannerImage.contrast`	`number`	Optional	Contrast.
`profileStyle.bannerImage.tintHex`	`null \| string`	Optional	Tint Hex.
`profileStyle.bannerImage.tintOpacity`	`number`	Optional	Tint Opacity.
`profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`profileStyle.avatarImage.brightness`	`number`	Optional	Brightness.
`profileStyle.avatarImage.contrast`	`number`	Optional	Contrast.
`profileStyle.avatarImage.tintHex`	`null \| string`	Optional	Tint Hex.
`profileStyle.avatarImage.tintOpacity`	`number`	Optional	Tint Opacity.
`profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`profileStyle.profileBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`profileStyle.profileBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.profileBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`profileStyle.pageBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`profileStyle.pageBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.pageBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`profileStyle.panelBackgroundFill.mode`	`string`	Optional	Mode. Allowed values: "default", "gradient", "solid".
`profileStyle.panelBackgroundFill.gradient`	`null \| object`	Optional	Gradient.
`profileStyle.panelBackgroundFill.solidHex`	`null \| string`	Optional	Solid Hex.
`profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`backgroundUrl`	`null \| string`	Required	Resolved background URL, or null when unavailable.
`archivedAt`	`number`	Optional	Archiving time; null when active. Set on archived list rows (`members.listArchivedPage`).

Errors

400 · JSON error

Request failed (BAD_REQUEST).

401 · JSON error

Missing or invalid API key. Use Authorization: Bearer <token>.

403 · JSON error

Requires messaging: read; ownership or feature restrictions may also deny access.

404 · JSON error

Request failed (NOT_FOUND).

409 · JSON error

conflict.

429 · JSON error

API rate limit exceeded (1000 requests per minute). Retry shortly.

500 · JSON error

internal server error.

503 · JSON error

Object storage is not configured. Set MinIO (or compatible S3) env vars to upload files.

Responses

Successful response.

JSON

[
  {
    "_id": "11111111-1111-4111-8111-111111111111",
    "userId": "11111111-1111-4111-8111-111111111111",
    "directoryId": "11111111-1111-4111-8111-111111111111",
    "sideSystemId": "11111111-1111-4111-8111-111111111111",
    "subSystemId": "11111111-1111-4111-8111-111111111111",
    "name": "River",
    "displayName": "River",
    "pronouns": "they/them",
    "avatar": "demo",
    "background": "demo",
    "updatedAt": 1767225600000,
    "profileStyle": null,
    "avatarUrl": null,
    "backgroundUrl": null
  }
]

Example values are illustrative demo data.

List chat as members

Parameters

Response schema

200

Errors

Request example

Responses

List chat as members

Parameters

Response schema

200

Errors

Request example

Responses