> ## 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. # Share a member site and control who opens it > Set a member site's visibility, learn who can open it as a guest, owner, member or company admin, and share it with members, a downline or a segment with view or copy permission. Two things decide who can open a member site: its visibility and its shares. Visibility is a setting on the site. Shares are a list of audiences you add to it. This page covers both, who can open a site in each case, and what a share grants and doesn't. ## Choose a visibility A site is `private` or `public`. A new site is private. You set it when you [add the site](https://docs.fluid.app/api-reference/sites/add-a-site.md) or [change it](https://docs.fluid.app/api-reference/sites/change-a-site.md). A company admin sets a company site's visibility with [Change a member site](https://docs.fluid.app/api-reference/member-sites/change-a-member-site.md). The change takes effect as soon as you save it. Visibility applies only once a site is published. A draft site or a taken-down site isn't open to members whatever its visibility says. See [Know draft and published](https://docs.fluid.app/member-sites/publishing.md#know-draft-and-published). ## Know who can open a site The answer depends on who is asking and on the site's state. | Viewer | A published public site | A published private site | | - | - | - | | A guest | Opens | Sent to sign in | | The site's owner | Opens | Opens | | Another signed-in member | Opens | Opens only if a share matches them. Otherwise not found | | A company admin | Opens | Opens | * **A guest is never told whether a site exists.** A guest who asks for anything but a published public site is sent to sign in, and a missing site and a private site look the same. * **A signed-in member outside the audience gets not found.** The answer is the same as for a site that doesn't exist. * **A draft and a taken-down site open for no member.** The owner and company admins included. Preview a draft instead. See [Preview the draft](https://docs.fluid.app/member-sites/publishing.md#preview-the-draft). * **A company site's owner is every company admin.** A member's site has one owner, the member who built it. An admin who isn't the owner opens a member's published private site as an admin. * **A company admin is a signed-in member whose user is an admin of the company.** Admin access to a site's files and pages is separate: see [Build with the APIs](https://docs.fluid.app/member-sites/apis.md). * **A site whose owner is no longer an active member opens only for company admins.** That holds whether it is public or private. * **A branch is private and unshareable.** Only its owner and company admins open it. A site opens at `/accounts/` on your company's own domain. See [what a member site is](https://docs.fluid.app/member-sites/overview.md#what-a-member-site-is). ## Serve a company site to your members A company site is built by your company's admins for your members. Admins create and edit it; members are its audience. It isn't an admins-only site. * **Every member:** make it `public`. Guests open it too. * **Some members, by role or country:** keep it `private` and share it with a segment: a member type, a country, or both. A member a segment matches opens it; any other member gets not found. Add one share per segment you want to serve, because shares combine. This replaces the countries and member types of theme member sites, which are deprecated. See [Share a site](#share-a-site). * **Named members:** share it with a member, the same way. A downline share isn't available for a company site, because a company admin can't make one. * **Members can't hide it:** mark it `required` with [Change a member site](https://docs.fluid.app/api-reference/member-sites/change-a-member-site.md). A member it reaches can't remove a required company site from their account menu. See [Sites home](https://docs.fluid.app/member-sites/sites-home.md). A share a company admin makes isn't limited by the company's member messaging policy. See [Follow the messaging policy](#follow-the-messaging-policy). ## Share a site A share names one audience and a permission. Add as many as you need. They combine, and a member who matches several shares gets the highest permission. | Audience | Who it reaches | | - | - | | One member | The member you name | | The sharer's downline | Every member below the member who made the share, on the enrollment tree. A company admin can't make this share, because a downline belongs to a member | | A segment | The company's members of a member type, in a country, both, or neither. A segment with neither reaches every member the sharer can reach | A member's country is their user's country, else the company's default country. A segment matches a blank field to any value. | Permission | What the audience can do | | - | - | | `view` | Open the site | | `copy` | Open the site, and copy it into a site of their own | For a member's site, the member who owns it shares it. For a company site, a company admin shares it. Sharing a member's site is the member's to do, so an admin can't share it. ### Use the shares API * **A member's shares:** [List a site's shares](https://docs.fluid.app/api-reference/site-shares/list-a-sites-shares.md), [Share a site](https://docs.fluid.app/api-reference/site-shares/share-a-site.md), [Change a share's permission](https://docs.fluid.app/api-reference/site-shares/change-a-shares-permission.md) and [Stop sharing with an audience](https://docs.fluid.app/api-reference/site-shares/stop-sharing-with-an-audience.md). * **A company site's shares, and any site's shares for an admin:** [List a site's shares](https://docs.fluid.app/api-reference/member-site-shares/list-a-sites-shares.md), [Share a company site](https://docs.fluid.app/api-reference/member-site-shares/share-a-company-site.md), [Change a share's permission](https://docs.fluid.app/api-reference/member-site-shares/change-a-shares-permission.md) and [Delete a share](https://docs.fluid.app/api-reference/member-site-shares/delete-a-share.md). * **Find whom a member can share with:** [Search the share targets](https://docs.fluid.app/api-reference/site-share-targets/search-the-share-targets.md) lists matching members, the member types and countries a segment can name, and which audiences the member's company allows. A few rules to know: * **Sharing the same audience twice writes nothing.** The request returns the share that exists, with its permission unchanged. Change the permission with [Change a share's permission](https://docs.fluid.app/api-reference/site-shares/change-a-shares-permission.md). * **A share changes only its permission.** To change who it names, delete it and add another. * **A share never names an email address.** It names a member, a member type or a country. * **You can't share with yourself or with a member of another company.** Both are refused, and so is a member type or country the company doesn't have. * **An admin can list and delete the shares of any site in the company.** An admin can't create or change the shares of a member's site. * **A deleted share closes access on the member's next request.** Another share that still matches keeps it open. ## Follow the messaging policy A member shares the way a member messages. The company's [Member messaging policy](https://docs.fluid.app/api/guides/messaging.md#set-what-members-can-see) limits whom a member can share with, and a share a member made is checked against it each time someone opens the site, not only when the share is made. | `directory_scope` | What a member can share with | | - | - | | `all_members` | Any audience. A member share can name any active member of the company | | `team_graph` | One member in the sharer's Team Graph, or the sharer's downline. A segment is refused | | `no_direct_messages` | No one | * **A company without a saved policy behaves as `all_members`.** * **A share the policy no longer allows stops working.** Narrowing the policy closes the access of those shares with nobody rewriting them, and widening it brings them back. * **A share a company admin made isn't limited by the policy.** It matches under every setting. * **A member who isn't in the sharer's Team Graph gets nothing from that share.** A member or sharer with no place in the graph is in no Team Graph. [Search the share targets](https://docs.fluid.app/api-reference/site-share-targets/search-the-share-targets.md) tells a member which audiences their policy allows. It allows 30 requests a minute, counted together with the messaging recipient search. ## Know what a share grants A share is a way in. It grants: * **Opening a private site.** A member the share matches opens a published private site. * **Copying, with `copy` permission.** A member can copy a site they can open when a share with `copy` matches them. A member who can open a site but has no `copy` share is refused. See [Copy a site](https://docs.fluid.app/member-sites/publishing.md#copy-a-site). * **A place in the member's menu.** A published site a share reaches a member for appears in that member's account menu. See [Sites home](https://docs.fluid.app/member-sites/sites-home.md). A share doesn't grant: * **Changes.** A share holder can't edit, publish, delete or share the site. Only the owner can, and an admin can take it down. * **The owner's data.** A share holder, and every other visitor, gets no member data from the site's scripts. Only the signed-in owner of a member's site does. See [Know who gets data](https://docs.fluid.app/member-sites/site-scripts.md#know-who-gets-data). * **Featuring or pinning.** A company that features a site shares it with no one, and a member who pins a site gets no access from the pin. * **Access to a draft.** A share on a draft or taken-down site opens nothing until the site is published. * **Anything beyond the policy.** A share reaches only the members the sharer's messaging policy lets it reach. A member can remove a shared site from their own menu. That changes what their menu lists. It never changes who can open the site by its address. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.