Florality

GET

/api/v1/front

front: 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
`memberIds`	`array<string>`	Required	Associated member identifiers.
`members`	`array<object>`	Required	Members.
`members[]._id`	`string`	Required	Unique identifier.
`members[].userId`	`string`	Required	Owning account identifier.
`members[].directoryId`	`string`	Required	Containing folder identifier.
`members[].sideSystemId`	`string`	Optional	Side System Id.
`members[].subSystemId`	`string`	Optional	Sub System Id.
`members[].name`	`string`	Required	Name of the resource.
`members[].displayName`	`string`	Optional	Display name.
`members[].pronouns`	`string`	Optional	Member pronouns.
`members[].avatar`	`string`	Optional	Avatar storage reference.
`members[].about`	`string`	Optional	Member profile text.
`members[].aboutTags`	`array<string>`	Required	Tags attached to the profile text. Labels shown on the member About card (same semantics as custom-field tags).
`members[].background`	`string`	Optional	Background storage reference.
`members[].archivedAt`	`number`	Optional	Archiving time; null when active.
`members[].createdAt`	`number`	Optional	Creation time.
`members[].updatedAt`	`number`	Optional	Most recent update time.
`members[].deletedAt`	`number`	Optional	Deletion time; null when active.
`members[].purgeAt`	`number`	Optional	Purge At.
`members[].originalDirectoryId`	`string`	Optional	Original Directory Id.
`members[].profileStyle`	`null \| object`	Required	Profile presentation settings.
`members[].profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`members[].profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`members[].profileStyle.memberName`	`object`	Optional	Member Name.
`members[].profileStyle.bannerImage`	`object`	Optional	Banner Image.
`members[].profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`members[].profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`members[].profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`members[].profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`members[].profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`members[].profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`members[].profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`members[].profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`members[].profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`members[].profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`members[].avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`members[].backgroundUrl`	`null \| string`	Required	Resolved background URL, or null when unavailable.
`members[].linkedSubSystems`	`array<object>`	Optional	Linked Sub Systems. Sub systems that list this member as their linked profile (`sub_systems.linked_member_id`). Distinct from `subSystemId` (member row lives inside a sub system).
`members[].linkedSubSystems[]._id`	`string`	Required	Unique identifier.
`members[].linkedSubSystems[].name`	`string`	Required	Name of the resource.
`members[].linkedSubSystems[].sideSystemId`	`string`	Required	Side System Id.
`activeSessions`	`array<object>`	Required	Active Sessions.
`activeSessions[]._id`	`string`	Required	Unique identifier.
`activeSessions[].userId`	`string`	Required	Owning account identifier.
`activeSessions[].memberId`	`string`	Required	Associated member identifier.
`activeSessions[].sideSystemId`	`null \| string`	Required	Side System Id.
`activeSessions[].subSystemId`	`null \| string`	Required	Sub System Id.
`activeSessions[].startedAt`	`number`	Required	Started At.
`activeSessions[].endedAt`	`number`	Optional	Ended At.
`activeSessions[].note`	`string`	Optional	Note.
`activeSessions[].createdBy`	`string`	Optional	Created By.
`activeSessions[].createdManually`	`boolean`	Optional	Created Manually. Allowed values: false, true.
`activeSessions[].editedAt`	`number`	Optional	Edited At.
`activeSessions[].editedManually`	`boolean`	Optional	Edited Manually. Allowed values: false, true.
`activeSessions[].typeKey`	`null \| string`	Optional	Type Key.
`primaryMemberId`	`null \| string`	Required	Primary Member Id.
`primaryNote`	`string`	Optional	Primary Note.
`tieredPresence`	`array<object>`	Required	Tiered Presence.
`tieredPresence[].memberId`	`string`	Required	Associated member identifier.
`tieredPresence[].tierKey`	`string`	Required	Tier Key.
`tieredPresence[].tierDisplayName`	`string`	Required	Tier Display Name.
`tieredPresence[].note`	`string`	Optional	Note.

Errors

401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires front: 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/front' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

{
  "memberIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "members": [
    {
      "_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",
      "about": "A note from our demo system.",
      "aboutTags": [
        "A note from our demo system."
      ],
      "background": "demo",
      "createdAt": 1767225600000,
      "updatedAt": 1767225600000,
      "profileStyle": null,
      "avatarUrl": null,
      "backgroundUrl": null,
      "linkedSubSystems": [
        {
          "_id": "11111111-1111-4111-8111-111111111111",
          "name": "River",
          "sideSystemId": "11111111-1111-4111-8111-111111111111"
        }
      ]
    }
  ],
  "activeSessions": [
    {
      "_id": "11111111-1111-4111-8111-111111111111",
      "userId": "11111111-1111-4111-8111-111111111111",
      "memberId": "11111111-1111-4111-8111-111111111111",
      "sideSystemId": null,
      "subSystemId": null,
      "startedAt": 1767225600000,
      "endedAt": 1767225600000,
      "note": "demo",
      "createdBy": "demo",
      "createdManually": false,
      "editedAt": 1767225600000,
      "editedManually": false,
      "typeKey": null
    }
  ],
  "primaryMemberId": null,
  "primaryNote": "demo",
  "tieredPresence": [
    {
      "memberId": "11111111-1111-4111-8111-111111111111",
      "tierKey": "demo",
      "tierDisplayName": "River",
      "note": "demo"
    }
  ]
}

Example values are illustrative demo data.

Response schema

200

Successful response.

Name	Type	Required	Description
`memberIds`	`array<string>`	Required	Associated member identifiers.
`members`	`array<object>`	Required	Members.
`members[]._id`	`string`	Required	Unique identifier.
`members[].userId`	`string`	Required	Owning account identifier.
`members[].directoryId`	`string`	Required	Containing folder identifier.
`members[].sideSystemId`	`string`	Optional	Side System Id.
`members[].subSystemId`	`string`	Optional	Sub System Id.
`members[].name`	`string`	Required	Name of the resource.
`members[].displayName`	`string`	Optional	Display name.
`members[].pronouns`	`string`	Optional	Member pronouns.
`members[].avatar`	`string`	Optional	Avatar storage reference.
`members[].about`	`string`	Optional	Member profile text.
`members[].aboutTags`	`array<string>`	Required	Tags attached to the profile text. Labels shown on the member About card (same semantics as custom-field tags).
`members[].background`	`string`	Optional	Background storage reference.
`members[].archivedAt`	`number`	Optional	Archiving time; null when active.
`members[].createdAt`	`number`	Optional	Creation time.
`members[].updatedAt`	`number`	Optional	Most recent update time.
`members[].deletedAt`	`number`	Optional	Deletion time; null when active.
`members[].purgeAt`	`number`	Optional	Purge At.
`members[].originalDirectoryId`	`string`	Optional	Original Directory Id.
`members[].profileStyle`	`null \| object`	Required	Profile presentation settings.
`members[].profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`members[].profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`members[].profileStyle.memberName`	`object`	Optional	Member Name.
`members[].profileStyle.bannerImage`	`object`	Optional	Banner Image.
`members[].profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`members[].profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`members[].profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`members[].profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`members[].profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`members[].profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`members[].profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`members[].profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`members[].profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`members[].profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`members[].avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`members[].backgroundUrl`	`null \| string`	Required	Resolved background URL, or null when unavailable.
`members[].linkedSubSystems`	`array<object>`	Optional	Linked Sub Systems. Sub systems that list this member as their linked profile (`sub_systems.linked_member_id`). Distinct from `subSystemId` (member row lives inside a sub system).
`members[].linkedSubSystems[]._id`	`string`	Required	Unique identifier.
`members[].linkedSubSystems[].name`	`string`	Required	Name of the resource.
`members[].linkedSubSystems[].sideSystemId`	`string`	Required	Side System Id.
`activeSessions`	`array<object>`	Required	Active Sessions.
`activeSessions[]._id`	`string`	Required	Unique identifier.
`activeSessions[].userId`	`string`	Required	Owning account identifier.
`activeSessions[].memberId`	`string`	Required	Associated member identifier.
`activeSessions[].sideSystemId`	`null \| string`	Required	Side System Id.
`activeSessions[].subSystemId`	`null \| string`	Required	Sub System Id.
`activeSessions[].startedAt`	`number`	Required	Started At.
`activeSessions[].endedAt`	`number`	Optional	Ended At.
`activeSessions[].note`	`string`	Optional	Note.
`activeSessions[].createdBy`	`string`	Optional	Created By.
`activeSessions[].createdManually`	`boolean`	Optional	Created Manually. Allowed values: false, true.
`activeSessions[].editedAt`	`number`	Optional	Edited At.
`activeSessions[].editedManually`	`boolean`	Optional	Edited Manually. Allowed values: false, true.
`activeSessions[].typeKey`	`null \| string`	Optional	Type Key.
`primaryMemberId`	`null \| string`	Required	Primary Member Id.
`primaryNote`	`string`	Optional	Primary Note.
`tieredPresence`	`array<object>`	Required	Tiered Presence.
`tieredPresence[].memberId`	`string`	Required	Associated member identifier.
`tieredPresence[].tierKey`	`string`	Required	Tier Key.
`tieredPresence[].tierDisplayName`	`string`	Required	Tier Display Name.
`tieredPresence[].note`	`string`	Optional	Note.

Responses

Successful response.

JSON

{
  "memberIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "members": [
    {
      "_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",
      "about": "A note from our demo system.",
      "aboutTags": [
        "A note from our demo system."
      ],
      "background": "demo",
      "createdAt": 1767225600000,
      "updatedAt": 1767225600000,
      "profileStyle": null,
      "avatarUrl": null,
      "backgroundUrl": null,
      "linkedSubSystems": [
        {
          "_id": "11111111-1111-4111-8111-111111111111",
          "name": "River",
          "sideSystemId": "11111111-1111-4111-8111-111111111111"
        }
      ]
    }
  ],
  "activeSessions": [
    {
      "_id": "11111111-1111-4111-8111-111111111111",
      "userId": "11111111-1111-4111-8111-111111111111",
      "memberId": "11111111-1111-4111-8111-111111111111",
      "sideSystemId": null,
      "subSystemId": null,
      "startedAt": 1767225600000,
      "endedAt": 1767225600000,
      "note": "demo",
      "createdBy": "demo",
      "createdManually": false,
      "editedAt": 1767225600000,
      "editedManually": false,
      "typeKey": null
    }
  ],
  "primaryMemberId": null,
  "primaryNote": "demo",
  "tieredPresence": [
    {
      "memberId": "11111111-1111-4111-8111-111111111111",
      "tierKey": "demo",
      "tierDisplayName": "River",
      "note": "demo"
    }
  ]
}

Example values are illustrative demo data.

Get front

Parameters

Response schema

200

Errors

Request example

Responses

Get front

Parameters

Response schema

200

Errors

Request example

Responses