> ## 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 in the account menu and the sites home > See which member sites a member's account menu lists, where /accounts opens, and how members pin sites, choose a home site and remove sites, and how a company features sites for everyone. A member opens their sites from the account menu, and `/accounts` takes them to one of them. This page covers what the menu lists, where `/accounts` opens, and the choices a member and a company can make: pins, a home site, removals and featured sites. None of these choices gives anyone access to a site. They only arrange what the menu shows. The CLI has no command for any of this. Use the member API for a member's choices and the company API for the company's. ## Read the account menu Fluid draws the account menu outside the site's frame, on every page. Read the same menu with [Show the member's account menu](https://docs.fluid.app/api-reference/site-menu/show-the-members-account-menu.md). It lists the sites a member can open in four groups: | Group | What it holds | | - | - | | The company's sites | Published company sites a share reaches the member for, in the company's order. A required company site is always here | | The sites they built | The member's own sites, drafts included, oldest first. A taken-down site isn't listed | | The sites shared with them | Published sites that other members own and a share reaches the member for, which the member hasn't removed | | The sites they removed | Sites the member took out of their menu and a share still reaches them for | * **A site no share reaches is in no group.** A public site opens at its address, but it appears in a member's menu only when a share reaches that member. To list a company site for every member, share it with a segment that names no member type and no country. See [Share a site](https://docs.fluid.app/member-sites/sharing.md#share-a-site). * **A member's shared sites are capped at 100.** The menu lists the newest 100 and says how many it left out. A site the member pinned, a site the company features and the member's home site are listed even when they fall outside the newest 100. * **The menu is read when you ask.** A removal or a restored site shows in the next read. * **It takes a member's own credential, sent as a bearer token.** A request on the cookie mount is refused, and so is the credential order and subscription emails carry. See [Build with the APIs](https://docs.fluid.app/member-sites/apis.md#authenticate). ## Know where members land A member who opens `/accounts` is sent to one site. A guest is sent to sign in first. Fluid goes down this list and sends the member to the first site it can open at its home page: 1. The member's home site, when they chose one. 2. The first company site the member hasn't removed. 3. The first company site, when the member removed every one. 4. The member's own sites, newest first. Fluid skips a site the member can't open, and a site with no served home page. If none is left, `/accounts` shows a page that says the member has no site yet. So a site with no published home page never catches a member. See [Pages and menus](https://docs.fluid.app/member-sites/pages-and-menus.md#write-the-pages-file). The menu names the first of these as `landing_site_id`, before Fluid checks that it can open the site. ## Choose a home site A member can choose one site as their home. `/accounts` opens it first. * **Choose it with** [Choose the member's home site](https://docs.fluid.app/api-reference/site-home/choose-the-members-home-site.md). Clear it with [Clear the member's home site](https://docs.fluid.app/api-reference/site-home/clear-the-members-home-site.md), and `/accounts` opens where it would without a home. * **The site must be published.** It can be the member's own, a company site or a site shared with them. It doesn't have to be pinned. A site the member removed from their menu, or a draft, is refused. A site the member can't see is not found. * **A home that can't be opened is ignored.** If the site is unshared, taken down or removed from the menu, `/accounts` opens elsewhere. The choice is kept, and it takes effect again when the member can open the site. * **A member has one home.** Choosing another replaces it. ## Pin sites A pin marks a site a member uses most. Each member has their own pins. * **Pin with** [Pin a site to the member's menu](https://docs.fluid.app/api-reference/site-pins/pin-a-site-to-the-members-menu.md). The new pin goes after the member's other pins. [Unpin a site](https://docs.fluid.app/api-reference/site-pins/unpin-a-site.md) removes it. * **A member has at most 50 pins.** A stored pin counts toward the 50 even when the member can no longer open the site. * **A member pins only a site their menu lists.** That includes their own drafts. A site they removed from their menu is refused, and a site they can't see is not found. * **Pinning twice returns the pin that exists.** That holds even at the limit. * **A pin gives no access.** A pin of a site the member can no longer open stays stored and shows in no menu until they can open the site again. * **Order the pins with** [Order the member's pins](https://docs.fluid.app/api-reference/site-pins/order-the-members-pins.md). It puts the sites you name first, in the order you send them, and leaves the other pins after them in their old order. Send 1 to 50 ids, each once. An id that isn't one of the member's pins is ignored. * **Unpinning a featured site leaves it featured.** The menu marks each pinned site and lists the member's pins, in their order, as `pin_order`. ## Remove a site from the menu A member can take a site they didn't build out of their own menu. The site moves to the removed group. * **Remove with** [Remove a site from the member's menu](https://docs.fluid.app/api-reference/site-removals/remove-a-site-from-the-members-menu.md). The menu entry of a removed site carries a `removal_id`. Put the site back with [Restore a removed site](https://docs.fluid.app/api-reference/site-removals/restore-a-removed-site.md). * **A member can't remove their own sites, or a company site the company requires.** Both are refused. * **A removal changes only the member's menu.** It doesn't change the site for its owner, for anyone else it is shared with, or for who can open it by its address. It stays when the site is unshared and shared again. * **A removed site isn't pinned, featured or home.** The menu lists none of them for it. They come back if the member restores it. ## Feature sites for the company A company admin can feature sites. A featured site is listed first, in the company's order, in the menu of every member it is shared with. * **Feature with** [Feature a site](https://docs.fluid.app/api-reference/member-site-features/feature-a-site.md). Use [Stop featuring a site](https://docs.fluid.app/api-reference/member-site-features/stop-featuring-a-site.md) to undo it, [Order the featured sites](https://docs.fluid.app/api-reference/member-site-features/order-the-featured-sites.md) to set the order, and [List the featured sites](https://docs.fluid.app/api-reference/member-site-features/list-the-featured-sites.md) to read it. * **A company features at most 20 sites.** Featuring a site that is already featured returns the feature that exists. * **Only a published site can be featured.** It can be the company's or a member's. A draft, a taken-down site, a site whose owner is no longer an active member and a branch can't. A site that is featured and then taken down stays on the list, so an admin can stop featuring it. * **Featuring shares a site with no one.** A member sees a featured site only when it is shared with them. See [Share a site](https://docs.fluid.app/member-sites/sharing.md#share-a-site). * **Featuring writes nothing to the site.** A member's site keeps its version and history. * **A signed-in admin features.** A company API token can read the featured list but can't change it. The menu marks each featured site as `pinned_for_everyone`, and lists the company's features in the company's order as `company_pin_order`. ## Know the limits | What | Limit | | - | - | | Sites a member owns | 25 | | Pins a member keeps | 50 | | Home sites a member has | 1 | | Sites a company features | 20 | | Shared sites in a member's menu | The newest 100, plus pinned, featured and home sites | | Pages in a site | 50 | A company has no limit on the number of sites it owns. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.