> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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 on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. # Member sites v2 overview > Learn what a member site in member sites v2 is, who can own, publish, share and open one, how members find their sites, and the two ways to build one: the fluid member-site CLI and the member and company APIs. Member sites v2 replaces theme member sites, which are documented at [Member sites](https://docs.fluid.app/themes/member-storefront/member-sites.md), are deprecated and will be removed. Build new sites with member sites v2. It lets members and your company build their own pages. Theme member sites are access rules over pages in a storefront theme. A member site in v2 has its own layouts, pages, sections, snippets, assets and menus, and publishing or switching a theme never touches it. > [!NOTE] > > Member sites must be turned on for your company by Fluid. Until they are, every member site API request returns `404`. To ask for them, [contact support](https://docs.fluid.app/help/getting-help.md). ## What a member site is A member site is a small set of pages that a company or one of its members builds. Members open it on your company's own domain: ```text theme={null} https://shop.example.com/accounts/rileys-shop/about ``` The path is `/accounts//`. A site's home page is `/accounts/`. A site's pages don't render in the page you open. Fluid draws its own page around them and loads the site into a sandboxed frame on the same domain. The browser treats the frame as an anonymous origin, so a site's code can't use the signed-in member's login on its own. A site's JavaScript asks Fluid for the member's data instead, with `fluid.fetch`. See [Read viewer data in site scripts](https://docs.fluid.app/member-sites/site-scripts.md). Fluid also draws the account menu outside the frame on every page. A site can't hide or replace it. ## Know who owns a site Every site has one owner kind. | Owner | Who builds it | What company admins can do | | - | - | - | | A member | The member, for themselves. A member owns at most 25 sites | List, read, take down, delete and copy it. An admin can't change a member's site | | The company | A company admin | Everything, including building and publishing it | A member's credentials build a member's sites, and a company admin's build the company's. The [CLI page](https://docs.fluid.app/member-sites/cli.md#choose-the-login) shows which login to use. ## Know a site's status A site is in one of three states. | Status | What it means | | - | - | | `draft` | The site is new. Members can't open it, its owner included. Preview it while you build | | `published` | Members who are allowed to open it see its published pages | | `taken_down` | A company admin took it down. Members can't open it, and its owner can't publish it again | ## Publish a site Everything you write is a draft until you publish the site. Members see only published copies of pages, layouts, sections, snippets and settings. A file that was never published renders as missing. A few changes have no draft and take effect on a published site as soon as you write them: assets, `config/menus.json` and page rows. [Pages and menus](https://docs.fluid.app/member-sites/pages-and-menus.md#know-what-is-live-at-once) lists each one. Each publish is saved as a version of the site. You can list a site's versions and restore one with the API. A company can take a site down, and you can copy a site, try a change on a branch or delete a site. [Publish, restore, copy and take down a member site](https://docs.fluid.app/member-sites/publishing.md) covers each, and [List a site's versions](https://docs.fluid.app/api-reference/sites/list-a-sites-versions.md) and [Restore a site to a version](https://docs.fluid.app/api-reference/sites/restore-a-site-to-a-version.md) are the operations. To publish with the CLI, run `fluid member-site publish`. To publish with the API, see [Publish a site](https://docs.fluid.app/api-reference/sites/publish-a-site.md) for a member's site and [Publish a company site](https://docs.fluid.app/api-reference/member-sites/publish-a-company-site.md). ## Choose who can open a site A published site is `private` or `public`. A new site is private. | Visibility | Who can open it | | - | - | | `public` | Anyone, signed in or not | | `private` | The owner, company admins, and members a share matches. A signed-in member outside that audience gets a not-found answer, so the response never says whether the site exists | Sharing opens a private site to the members you choose. A share names one audience and a permission: * **Audience.** One member, the sharing member's downline, or a segment of the company's members. A segment is a member type, a country, both, or neither, which means every member the sharer can reach. * **Permission.** `view` opens the site. `copy` also lets the member copy it into a site of their own. A company's messaging policy limits who a member can share with. Sharing never lets anyone edit a site, and it doesn't give a share holder any of the owner's data. Only the owner of a member's site can share it. A company admin shares the company's sites. To copy a site, a member needs `copy` permission or must own it. A copy holds the original's published layouts, sections, snippets, pages, settings, text assets and menus, and starts as a draft that belongs to the member. See [Copy a site](https://docs.fluid.app/api-reference/sites/copy-a-site.md). [Share a member site](https://docs.fluid.app/member-sites/sharing.md) covers who can open a site in each case, what a share grants and how the messaging policy limits it. For the operations, see [Share a site](https://docs.fluid.app/api-reference/site-shares/share-a-site.md) for members and [Share a company site](https://docs.fluid.app/api-reference/member-site-shares/share-a-company-site.md) for admins. ## Find sites in the account menu A member's account menu lists the sites they can open in four groups: the company's sites, the sites they built, the sites shared with them, and the sites they removed. Read it with [Show the member's account menu](https://docs.fluid.app/api-reference/site-menu/show-the-members-account-menu.md). Members can arrange their own menu. None of these changes affects anyone else, and none gives access to a site the member can't already open. * **Remove a site from the menu.** The site moves to the removed group. A member can't remove their own sites or a company site the company requires. * **Pin sites.** Pinned sites come first, in an order the member chooses. A member can pin up to 50 sites. * **Choose a home site.** The member's account opens on their home site while they can still open it. The site must be published. Company admins can feature up to 20 sites. A featured site is listed first, in the company's order, in the menu of every member it is shared with. Featuring a site shares it with no one. [Member sites in the account menu](https://docs.fluid.app/member-sites/sites-home.md) covers the menu's groups, where `/accounts` opens and the limits. For these operations, see [Pin a site to the member's menu](https://docs.fluid.app/api-reference/site-pins/pin-a-site-to-the-members-menu.md), [Choose the member's home site](https://docs.fluid.app/api-reference/site-home/choose-the-members-home-site.md) and [Feature a site](https://docs.fluid.app/api-reference/member-site-features/feature-a-site.md). ## Declare what a site's scripts use A site's JavaScript reaches Fluid with `window.fluid.fetch`, which behaves like `fetch`, and reads the signed-in owner's data that way. Each path it calls needs a scope, such as `profile: read`. A site lists the scopes its scripts use in one file, `config/access.json`. The file is published with the site, and `fluid member-site lint` checks your scripts against it. Once a site has published a declaration, Fluid refuses a call whose scope the file lacks, and the owner's code reaches only what the file lists. See [Declare what a member site uses](https://docs.fluid.app/member-sites/access-declarations.md). ## Build a site You build a member site in one of two ways. Both write the same files and pages, so you can use them together. > [card] [The fluid member-site CLI](https://docs.fluid.app/member-sites/cli.md) > > Pull a site into a folder, edit it with your own tools, preview the draft, lint it, push it and publish it. > [card] [The member and company APIs](https://docs.fluid.app/member-sites/apis.md) > > Create sites, write their files and pages, publish, share and copy them from your own code. The member API at `/api/member/v2026-10/sites` builds a member's own sites with the member's credential. The company API at `/api/company/v2026-10/member-sites` oversees every site in the company and builds the company's sites with a company admin's credential. [Build member sites with the APIs](https://docs.fluid.app/member-sites/apis.md) covers the credentials and links every operation. Start with [Add a site](https://docs.fluid.app/api-reference/sites/add-a-site.md) for members and [Create a company site](https://docs.fluid.app/api-reference/member-sites/create-a-company-site.md) for admins. After you pick a way to build, read these pages in order: 1. [Build pages with Liquid](https://docs.fluid.app/member-sites/templates.md) covers the folder, the Liquid objects and the frame's rules. 2. [Pages, menus and settings](https://docs.fluid.app/member-sites/pages-and-menus.md) covers `config/pages.json`, `config/menus.json` and `config/settings.json`. 3. [Read viewer data in site scripts](https://docs.fluid.app/member-sites/site-scripts.md) covers `window.fluid.fetch`. 4. [Declare what a member site uses](https://docs.fluid.app/member-sites/access-declarations.md) covers `config/access.json`. 5. [Publish, restore, copy and take down a member site](https://docs.fluid.app/member-sites/publishing.md) covers publishing, versions, copies, branches, take-down and deletion. 6. [Share a member site](https://docs.fluid.app/member-sites/sharing.md) covers visibility and shares. 7. [Member sites in the account menu](https://docs.fluid.app/member-sites/sites-home.md) covers pins, the home site and featured sites. 8. [Build member sites with the APIs](https://docs.fluid.app/member-sites/apis.md) covers building without the CLI. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.