> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Databases > Turn reporting databases on or off for Mist, set how often your Fluid data syncs, request a sync, and see which roles can query the data. The Databases screen controls which reporting databases admins with reporting access can view in the Mist desktop app and query with Mist agents. It holds your company's Fluid database, which syncs on a schedule you set, and any databases from connectors you install. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **System**, select **Databases**. To open the screen, your role needs **Full access** for **Reporting Databases**, in the **Other** card on the role's **Permissions** tab. ## What's on the screen The introduction at the top of the screen has a **View Mist Documentation** link, which opens the Fluid docs in a new tab. Below it, the **Enabling a database carries risk** notice explains the risks of turning on a database. Turning on a database makes its contents queryable by Mist agents and by every admin who holds a reporting-database role, including any personal, financial, health or otherwise confidential data it holds. Query content and results may be processed by third-party AI model providers. Read the full notice on the screen before you turn on a database. If your settings can't load, the screen shows **Couldn't load reporting database settings** and a **Try Again** button. ### Fluid card The **Fluid** card is for syncing your company's Fluid data, such as orders, customers and products, into a dedicated reporting database. It has: * **Sync Now**: requests a sync. It's available only while the Fluid database is turned on. While the request is being sent, the button reads **Syncing...**. * **Last synced**: the date and time of the last sync, shown next to **Sync Now** once there's a sync to show. * **Sync every**: the number of hours between syncs, as a whole number of 1 or more. * A switch at the right of the card, next to **Sync every**, that turns syncing of the Fluid reporting database on or off. At the bottom of the card, a note says that Fluid charges per sync for database storage and transfer. It gives the cost range for each sync, which depends on the size of your database. ### Connectors The **Connectors** section lists the databases from your installed connectors. Each row shows the connector's name, a **via Fluid Connect** badge and a switch. The switch lets admins with reporting access view that connector's data in the Mist desktop app, with access tracked per user. If the list is empty, it shows **No connector databases yet** and a **Browse the Droplet Marketplace** button. ### Who has access The **Who has access** section shows, as badges, the roles that can view and query reporting databases in Mist. Each admin connects separately, and every connection is tracked by user. If no role is listed, the section says that only full-access admin roles hold the reporting-database permissions. **Manage Roles** opens the **Roles** screen. See [Roles](/help/admin/settings/roles). ## Turn on the Fluid database Read the **Enabling a database carries risk** notice near the top of the screen. On the **Fluid** card, turn on the switch at the right of the card. You see **Fluid reporting database updated**. To turn the Fluid database off, turn off the same switch. **Sync Now** is unavailable while the switch is off. ## Change how often Fluid data syncs On the **Fluid** card, enter a whole number of 1 or more in **Sync every**. Press Enter, or click outside the field. You see **Fluid reporting database updated**. If you enter a number that isn't whole, or is less than 1, the field goes back to the saved value and nothing is saved. ## Request a sync now On the **Fluid** card, click **Sync Now**. The Fluid database must be turned on. You see **Sync requested**, or **Sync requested. It will run on the next scheduler tick.** If the request fails, you see **Failed to request sync**. ## Turn a connector database on or off Read the **Enabling a database carries risk** notice near the top of the screen. Under **Connectors**, turn the switch at the end of the connector's row on or off. You see a message with the connector's name and **viewing data in Mist enabled** or **viewing data in Mist disabled**. ## Frequently asked questions The **Databases** item appears only if your role can manage reporting databases. Ask an admin who manages roles to edit your role: on the role's **Permissions** tab, open the **Other** card, then set **Reporting Databases** to **Full access**. See [Roles](/help/admin/settings/roles). Fluid Connect brings data from your other platforms into Fluid as reporting databases. Install a database-capable connector from the droplet marketplace, and its database appears under **Connectors**. If you have no connector databases yet, click **Browse the Droplet Marketplace** to open the marketplace. **Sync Now** works only while the Fluid database is turned on. Turn on the switch on the **Fluid** card first. The button is also unavailable while a sync request is being sent. You see **Failed to update setting**, and the screen reloads your saved settings, so the switch or field shows its saved value again. Make the change again. ## Related pages * [Settings](/help/admin/settings) * [Roles](/help/admin/settings/roles) * [Mist Apps](/help/admin/settings/mist-apps) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.