> ## 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 <token>; 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 APIs

> Choose the APIs for static V1 member sites, sharing and publishing, and distinguish them from compatibility endpoints.

Use the Member API to manage a member's own sites. Use bundle uploads to publish a static V1 site's build. Start with [Build a member site](https://docs.fluid.app/member-sites-v1/overview.md) for the app, SDK and CLI workflow.

## APIs for static V1 sites

| Task | Reference |
| - | - |
| Manage sites | [List](https://docs.fluid.app/api-reference/sites/list-the-members-sites.md), [add](https://docs.fluid.app/api-reference/sites/add-a-site.md), [read](https://docs.fluid.app/api-reference/sites/show-a-site.md), [change](https://docs.fluid.app/api-reference/sites/change-a-site.md) and [delete](https://docs.fluid.app/api-reference/sites/delete-a-site.md) |
| Publish a build | [Start a bundle upload](https://docs.fluid.app/api-reference/site-bundles/start-a-bundle-upload.md) and [publish the bundle](https://docs.fluid.app/api-reference/site-bundles/publish-a-bundle.md) |
| Find published builds | [List a site's bundles](https://docs.fluid.app/api-reference/site-bundles/list-a-sites-bundles.md) and [make an earlier bundle current](https://docs.fluid.app/api-reference/site-bundles/make-an-earlier-bundle-current-roll-back.md). Read the rollback restrictions in the reference before using it |
| Share access | [Search share targets](https://docs.fluid.app/api-reference/site-share-targets/search-the-share-targets.md), [list shares](https://docs.fluid.app/api-reference/site-shares/list-a-sites-shares.md), [share](https://docs.fluid.app/api-reference/site-shares/share-a-site.md), [change permission](https://docs.fluid.app/api-reference/site-shares/change-a-shares-permission.md) and [stop sharing](https://docs.fluid.app/api-reference/site-shares/stop-sharing-with-an-audience.md) |
| Set account preferences | [Pin a site](https://docs.fluid.app/api-reference/site-pins/pin-a-site-to-the-members-menu.md), [order pins](https://docs.fluid.app/api-reference/site-pins/order-the-members-pins.md), [unpin](https://docs.fluid.app/api-reference/site-pins/unpin-a-site.md), [choose a home site](https://docs.fluid.app/api-reference/site-home/choose-the-members-home-site.md) and [clear it](https://docs.fluid.app/api-reference/site-home/clear-the-members-home-site.md) |
| Inspect the owner's database | [List tables](https://docs.fluid.app/api-reference/site-data/list-the-tables-of-a-sites-database.md) and [read rows](https://docs.fluid.app/api-reference/site-data/read-the-rows-of-a-table-of-a-sites-database.md) with the site owner's Bearer token |
| Download the database | [Download a site's database](https://docs.fluid.app/api-reference/site-database/download-a-sites-database.md) |

Pins and the home site control the member's account navigation. They do not showcase a site on a public profile.

The owner database inspection APIs are read-only management APIs. They are separate from the database calls your site makes as a visitor. Follow [Inspect your site's data](https://docs.fluid.app/member-sites-v1/database.md#inspect-your-sites-data) for the owner workflow.

For database reads and writes inside your app, use [the member site database SDK](https://docs.fluid.app/member-sites-v1/database.md). Its tables and access rules come from `db/schema.json` and are published with the build.

## Compatibility endpoints

The **Member Sites compatibility** section keeps references for older integrations separate from the V1 workflow. Their existing links still work.

Current company-site APIs are grouped under **Website**. The **Company Liquid copy, publishing and versions** and **Company Liquid files and pages** groups are in **Member Sites compatibility** for company integrations that still use the older workflow.

* **Liquid copy, publishing and versions** and **Liquid files and pages** describe the older Liquid content workflow. Publish static builds with bundles instead of [Publish a site](https://docs.fluid.app/api-reference/sites/publish-a-site.md), [Git versions](https://docs.fluid.app/api-reference/sites/list-a-sites-versions.md) or [restore a Git version](https://docs.fluid.app/api-reference/sites/restore-a-site-to-a-version.md).
* [Copy a site](https://docs.fluid.app/api-reference/sites/copy-a-site.md) currently copies the older Liquid content, not a static V1 bundle. It does not create a working copy of a V1 build.
* **Older database backend** describes the older database status, setup, table, row and schema-statement operations. Those operations do not manage the V1 database declared in `db/schema.json`. The database download listed above does use the V1 database.
* **Account menu integration** contains [the member's account menu](https://docs.fluid.app/api-reference/site-menu/show-the-members-account-menu.md) and menu removals. The menu endpoint remains available for integrations that draw account navigation; publishing or sharing a V1 site does not require you to build that menu.

See [Publish a member site](https://docs.fluid.app/member-sites-v1/publishing.md) for the recommended CLI workflow, and [Share a site](https://docs.fluid.app/member-sites-v1/overview.md#share-a-site) for visibility, access and credited links.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.