> ## 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. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/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. # Public and company storefront endpoints > How the public storefront endpoints and the authenticated company endpoints differ: host, authentication, addressing, visible content, and fields. Every storefront resource has a public side and a company side. The public side is what a shopper's browser reads. The company side is how you manage the store's content. ## At a glance | | Public endpoints | Company endpoints | | - | - | - | | Paths | `/api/v202604/`, `/api/v202604//` | `/api/v202604/company/`, `/api/v202604/company//` | | Host | The store's own host: `https://.fluid.app` or a custom domain connected to the store | `https://api.fluid.app` | | Authentication | None | Bearer token | | How the store is identified | The request host | The token | | Addresses one resource by | `slug` | Numeric `id` | | Operations | List and show | List, show, create, update, delete | | Lists include | Live content only | Everything, whatever its state | | Errors | `404` when the host names no store, or the slug doesn't exist | `401` without a valid token, `403` without permission | ## Public endpoints Public endpoints need no token, so your storefront can call them straight from the browser. Fluid works out which store you mean from the host you call: ```bash theme={null} curl "https://acme.fluid.app/api/v202604/products" ``` The same request sent to `https://api.fluid.app` returns `404`, because that host names no store. What the public side returns: * **Lists show only live content.** A draft, scheduled, or switched-off resource never appears in a public list. See [Visibility, drafts, and scheduling](/storefront/visibility). * **Looking up a slug is looser.** A public show request can return a resource that isn't live yet, so preview links work. It carries `seo.indexable: false` so search engines skip it. * **Missing translations fall back.** A field that has no translation in the requested `lang` returns its default-language value. * **The public side never returns `403`.** A resource you can't see is either left out of a list or returns `404`. ## Company endpoints Company endpoints need a Bearer token and run on `https://api.fluid.app`. The token identifies the store: ```bash theme={null} curl "https://api.fluid.app/api/v202604/company/products" \ -H "Authorization: Bearer " ``` * **Reads** need the `storefront.view` permission, and **writes** need `storefront.update`. Older per-resource permissions, such as `products.update`, are also accepted. * A **droplet installation token** needs the `website` scope instead. See [Authentication](/api/authentication#droplet-installation-token). * Lists return every resource in any state. You can narrow them with `filter[status]`, and on every resource except products with `filter[active]`. The public side ignores both. * Responses add management fields the public side leaves out, such as `custom_slug` and `seo.id`. ## Which to use * **Rendering a storefront, or reading as a shopper would** — use the public endpoints on the store's host. * **Managing content, or reading content that isn't live** — use the company endpoints with a token. * **Checking what a shopper will see before you publish** — read the resource on the company side, then look it up by slug on the public side. Both sides accept `lang`, `q`, `sort`, `page[cursor]`, and `page[limit]` on lists. See [Find and create resources](/storefront/find-and-create).