> ## 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. # Developer > Find links to developer docs, API tokens and webhooks, set up the Fluid CLI and docs MCP server, and copy your Fluid SDK snippet. The **Developer** screen collects the resources you need to build on Fluid. It links to the documentation and your developer settings, shows how to set up developer tools, and gives you the Fluid SDK snippet for your website. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **System**, select **Developer**. To open the screen, your role needs at least **View only** for **Developer**, in the **Settings** card on the role's **Permissions** tab. See [Roles](/help/admin/settings/roles). ## What's on the screen If your role has **Full access** to **Developer**, the header has a **Manage Webhooks** button. It opens the [Webhooks](/help/admin/settings/webhooks) screen. ### Resource cards Under **Getting Started**, these cards link to resources. Click a card to open it. * **Documentation**: opens the [Fluid documentation](/introduction) home page in a new tab. * **API Reference**: opens the [API overview](/api/overview) in a new tab. * **Support & FAQ**: opens [Getting help](/help/getting-help) in a new tab. * **Webhooks**: opens the [Webhooks](/help/admin/settings/webhooks) screen, for sending event notifications to your external services. * **API Tokens**: opens the [API Tokens](/help/admin/settings/tokens) screen, where you issue and revoke the tokens that authenticate your API calls. * **Skills**: opens Fluid's agent skills for Claude Code, Cursor and other tools on GitHub, in a new tab. The card is marked **New**. * **Master the CLI**: opens the [Fluid CLI guide](/themes/cli#installation) in a new tab. * **Meet Mist**: opens the [Mist Apps](/help/admin/settings/mist-apps) screen, if your role has access to **Mist**. The card is marked **New**. ### Mist Desktop Below the cards, the **Meet Mist Desktop** banner, marked **New** and **Beta**, lets you download the Mist Desktop app. Click anywhere on the banner to start the download. * The button on the banner names the system the screen detected, for example **Download for Windows** or **Download for macOS (Apple Silicon)**. * If the button reads **Download for macOS** or **Download for macOS (Apple Silicon)**, an **Intel Mac? Get the x64 build** link appears below the banner. If your Mac has an Intel processor, use that link. It opens the Mist Desktop releases page in a new tab, where you can download the x64 build. * If the screen can't find a download for your system, it opens the Mist Desktop releases page instead. ### Developer tools Under **Set Up Your Developer Tools**, two cards help you set up the tools Fluid recommends for building on Fluid. * **Install the Fluid CLI**: shows commands that install the Fluid CLI and sign you in. The CLI lets you manage themes, portals, droplets and more from your terminal. **View the full CLI guide** opens the [Fluid CLI guide](/themes/cli#installation) in a new tab. * **Connect the Fluid Docs MCP server**: shows how to connect Claude Code, Cursor or another client that supports the Model Context Protocol (MCP) to Fluid's documentation, so you can search the docs without leaving your editor. It has setup steps for **Claude Code**, **Cursor**, **VS Code (Copilot)** and **Claude Desktop**. The docs MCP server is hosted and read-only, at `https://docs.fluid.app/mcp`. There's nothing to install, and you don't need an API token. It only searches published documentation. It can't read or change your company's data. To act on your store, use the Fluid API with a token from [API Tokens](/help/admin/settings/tokens). ### Fluid SDK The **Fluid SDK** card has a script snippet that embeds the Fluid SDK in your website or app, with your company's subdomain already filled in. To copy it, click the copy icon at the top right of the snippet. **Fluid SDK Documentation** opens the [SDK overview](/sdk/overview). Fluid-hosted storefronts already load the SDK, so add it only to sites Fluid doesn't host. For installation steps and configuration, see [Installation](/sdk/installation). ## Set up the Fluid CLI The **Install the Fluid CLI** card shows commands to install the CLI and sign in. For full installation steps and the CLI's commands, see the [Fluid CLI guide](/themes/cli#installation). ## Frequently asked questions On the [API Tokens](/help/admin/settings/tokens) screen. Click the **API Tokens** card on this screen, or select **API Tokens** under **System** in the Settings sidebar. If you bookmarked the API tokens section of this screen, the bookmark opens the **API Tokens** screen. ## Related pages * [Settings](/help/admin/settings) * [API Tokens](/help/admin/settings/tokens) * [Webhooks](/help/admin/settings/webhooks) * [Callbacks](/help/admin/settings/callbacks) * [Mist Apps](/help/admin/settings/mist-apps) * [Roles](/help/admin/settings/roles) * [API overview](/api/overview) * [Fluid CLI](/themes/cli) * [SDK overview](/sdk/overview) * [SDK installation](/sdk/installation) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.