Florality
FeaturesPricingSecurityFAQAbout
Sign upSign in
Public REST APIv1

REST reference & guides

Public REST APIv1

REST reference & guides

Get started

  • Overview
  • Authentication
  • Scopes
  • Errors

API reference

  • Members
  • Groups
  • Entries
  • Front
  • Appearance
  • Custom fields
  • Trash
  • Search
  • Member statuses
  • Systems
  • Messaging
  • Privacy buckets
  • Terminology
  • Friends
  • Subscriptions
  • Billing
  • Import
  • Social
  • Guestbook & poll
  • Group layout
  • Activity
  1. Documentation
API keys
Florality

Organise your system. One front at a time.

Get startedSign in

Product

  • Features
  • Pricing
  • Public REST API
  • Security

Company

  • About
  • Our team
  • Changelog
  • Contact

Resources

  • FAQ
  • Trust & Safety
  • Privacy Policy
  • Terms of Service
  • Refunds and cancellation

© 2026 Florality. All rights reserved.

Privacy·Terms·

Public REST API

Versioned routes at /api/v1 for integrations and scripts. Authenticate with API keys (Bearer tokens), not your browser session.

v1REST · JSONSettings → API keys

Authentication

Bearer API keys on every request. No session cookies.

Read guide

Scopes

Per-resource none, read, or read_write access.

Read guide

Errors

HTTP status codes and JSON error bodies.

Read guide

Base URL

Base URL

Production https://api.floralitys.com/api/v1

Example https://api.floralitys.com/api/v1/members

Exporting account data

No single endpoint returns a full account dump. Use the dashboard export or script the API below.

Simplest

Option A: Dashboard export

One JSON file with members, notes, front history, messaging, billing, and more. Best for a one-off human migration.

Read guide
Automated

Option B: REST script

Create a key with Read (or Read + Write) on every scope you need. Paginate where nextCursor appears.

Read guide

For REST scripting, use the same Authorization: Bearer token for JSON routes and for member media URLs returned in responses. Fetch parents before children so foreign keys resolve when you import elsewhere.

  1. Account shell: Systems, Terminology, Appearance, Billing / Subscriptions
  2. Structure: Groups & folders (list + tree); per group, Group layout
  3. Members: Members list (repeat with sideSystemId / subSystemId when using side or sub-systems)
  4. Per member: Custom fields; Member statuses assignments
  5. Notes (entries): Entries — at most 100 rows per list call. For large libraries, use GET /api/v1/entries?memberId={uuid}&limit=100 per member, or Search /catalog then GET /api/v1/entries/{entryId}
  6. Front: Front — current state, then paginate GET /api/v1/front/history until nextCursor is null
  7. Privacy & social: Privacy buckets, Friends, Social profile, then Guestbook & poll per widget
  8. Messaging: Messaging — /bootstrap, then paginate channel messages with nextCursor
  9. Operational extras: Activity, Import runs
  10. Trash (optional): Trash for soft-deleted items before purge
  11. Binary media: GET /api/v1/members/{memberId}/media?kind=avatar|background with URLs and v from member JSON

Limitations

REST exposes active account data per scope; not every dashboard preference (e.g. keybinds). Activity is a recent feed, not a full audit log. For a complete snapshot without scripting, use Settings → Export.

API reference

Endpoint guides with request examples, response shapes, and scope requirements.

Members

List, create, update, delete, media.

Read guide

Groups

Groups and folder tree.

Read guide

Entries

Notes: list, create, trash, restore.

Read guide

Front

Fronters, history, order, tier presence.

Read guide

Appearance

Theme, colors, typography.

Read guide

Custom fields

Definitions and per-member values.

Read guide

Trash

Soft-deleted items and bulk purge.

Read guide

Search

Catalog and ILIKE search.

Read guide

Subscriptions

Billing row (read).

Read guide

Billing

Entitlements and plan usage.

Read guide

Import

Migration run tracking.

Read guide

Activity

Recent sessions and updates.

Read guide

Member statuses

Definitions and assignments.

Read guide

Systems

Side and sub systems.

Read guide

Messaging

Channels and messages.

Read guide

Privacy buckets

Buckets and assignments.

Read guide

Terminology

Global and scoped labels.

Read guide

Friends

Requests and friend-visible data.

Read guide

Social

Links, widgets, theme.

Read guide

Guestbook & poll

Widget messages and votes.

Read guide

Group layout

Folder order and separators.

Read guide

Response bodies

Success JSON is returned directly in the response body (no envelope wrapper). Reference pages document example JSON per endpoint. Shared errors: Errors.