> ## 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. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > 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. # Droplets > Find droplets in the marketplace, install one and choose what it can access, then open it, change its permissions or uninstall it. The Droplets screen is the droplet marketplace. Use it to browse droplets, install the ones you want, and manage the droplets you've installed. ## Where to find it In the admin sidebar, under **Droplets**, select **Marketplace**. To open this screen, your role needs **View only** or **Full access** for **Droplets**. To install droplets, change their permissions, uninstall them or use **New Droplet**, it needs **Full access**. On the [Roles](/help/admin/settings/roles) screen, **Droplets** is in the **Tools & Messaging** card. Open the card and set access from the **Droplets** area's menu, not the card's. ## What's on the screen The page header reads **Droplets**. If your role has **Full access** for **Droplets**, the header also has **New Droplet**. **New Droplet**, and the **Edit** button on a droplet your company built (also **Full access**), are for building and publishing your own droplet. See [Build and publish a Fluid droplet](/guides/creating-droplets). ### Fluid Connect The **Fluid Connect** section at the top holds the back-office connector droplets: ByDesign, Infotrax, Exigo and Pillars. It appears only when at least one of them is available. When there are more cards than fit, scroll through them with the arrow buttons. On a wide screen they appear when you point at the section; on a narrow screen, such as a phone, they're always shown. Click a card to open the connector's details. These droplets also appear in the **Droplets** list below. For connector setup, see the setup guide for your system in **Related pages** at the end of this page. ### Droplets list The **Droplets** section shows the marketplace's droplets as cards. Droplets your company has installed come first. * The search box, which reads **Search droplets...**, matches a droplet's name, its short summary or its category names. * The category menu next to the search box starts at **All Categories**. Choose a category to show only its droplets. If nothing matches your search or category, the section says no droplets were found. Each card shows: * The droplet's logo, its title and up to two lines of summary. * **Installed**, with a check mark, if your company has installed the droplet. * **Theme Blocks**, if the droplet adds blocks to your theme editor. * A category badge: the droplet's first category, or the category you've filtered by. If the droplet has more categories, a badge such as **+ 2** shows how many more; point at it to see them all. Click a card to open the droplet's details. ### A droplet's details The page header shows the droplet's name. On a droplet your company hasn't installed, the header also has **Install** if your role has **Full access** for **Droplets**. Until you install a droplet, its screen shows its marketplace listing: * The droplet's logo and name, and **Category**: the categories it belongs to. * **Theme Extension**: if the droplet adds blocks to your theme editor, this card says **This app adds blocks to your theme editor.** and, when it has one, the version. * Images and videos. The first is shown large, with up to three more beside or below it, and a count such as **+3 more** on the last when there are others. Click one to view it full screen, use the arrows or the arrow keys to move between them, and click the close button or press Esc to close. * **Overview**: the droplet's description, followed by its list of features. ## Install a droplet In the **Droplets** list or the **Fluid Connect** section, click the droplet's card. Click **Install** in the page header. Some droplets install as soon as you click it. If the droplet requests permissions, a dialog titled **Install** followed by the droplet's name opens first. The dialog lists each permission the droplet requests, with a short description. All of them start checked. Uncheck any you don't want to grant. Click **Install** in the dialog. The button reads **Installing...** while the droplet installs. You see **Droplet installed successfully**. The dialog closes and the page shows the droplet's own screen. To back out instead, click **Cancel**. If the install fails, you see **Error installing droplet**. ### Droplet permissions The standard permissions you can grant when you install a droplet or edit its permissions: | Permission | Description on screen | | :- | :- | | **Main** | Access to core application features and dashboard | | **Prospects** | View and manage prospect records | | **Members** | View and manage member profiles and data | | **Web** | Access to web content and page management | | **Settings** | Read and modify application settings | | **Products** | View and manage product catalog | | **Orders** | View and manage customer orders | | **Users** | View and manage user accounts | | **Website** | Access to website configuration and content | | **Header Menus** | Manage header navigation menus | | **Payments** | Access to payment processing and transactions | ## Open an installed droplet In the sidebar, under **Droplets**, each installed droplet is listed below **Marketplace** with its logo. Click the droplet's name to open it. A name longer than 16 characters is cut short; point at it to see the full name. You can also click the droplet's card in the **Droplets** list, where it shows **Installed**. An installed droplet's screen shows the droplet's own screen below the page header, in place of the marketplace listing. If your role has **Full access** for **Droplets**, the page header has a three-dot menu with **Edit Permissions** and **Uninstall**. If the droplet's screen shows **This app couldn’t connect to Fluid. Reload to try again.**, reload the page. ## Change a droplet's permissions In the sidebar, under **Droplets**, click the droplet's name, or click its card in the **Droplets** list. In the page header, open the three-dot menu and choose **Edit Permissions**. The **Edit Permissions** panel opens on the right. The panel lists the permissions you can grant, and the ones the droplet has now are checked. Check a permission to grant it, or uncheck it to remove it. Click **Save**. It's available once you've changed something, and reads **Saving...** while it works. You see **Permissions updated successfully**. As the panel says, changes take effect immediately after saving. To close the panel without saving, click **Cancel**. If the save fails, you see **Failed to update permissions**. ## Uninstall a droplet In the sidebar, under **Droplets**, click the droplet's name, or click its card in the **Droplets** list. In the page header, open the three-dot menu and choose **Uninstall**. The **Uninstall Droplet?** dialog asks whether you're sure you want to uninstall the droplet, by name. Click **Uninstall**, or click **Cancel** to keep the droplet. You see **Droplet disconnected successfully**. The droplet's installation is removed: its screen shows the marketplace listing and **Install** again, and its card no longer shows **Installed**. You can install it again later. If the uninstall fails, you see **Error disconnecting droplet**. ## Frequently asked questions **Install** shows only on a droplet your company hasn't installed; on an installed droplet, the three-dot menu takes its place. Installing a droplet, and the three-dot menu, need **Full access** for **Droplets**. Ask an admin who manages roles to edit your role: on the role's **Permissions** tab, open the **Tools & Messaging** card, then set **Droplets** to **Full access**. See [Roles](/help/admin/settings/roles). The section appears only when at least one of the ByDesign, Infotrax, Exigo or Pillars connector droplets is available. Other droplets are in the **Droplets** list. ## Related pages * [Droplets](/concepts/droplets) * [Roles](/help/admin/settings/roles) * [Databases](/help/admin/settings/databases) * [Connect Exigo to Fluid](/setup/connect-exigo) * [Connect ByDesign to Fluid](/setup/connect-bydesign) * [Connect InfoTrax to Fluid](/setup/connect-infotrax) * [Connect Pillars to Fluid](/setup/connect-pillars) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.