> ## 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. # Settings > Open Settings from the admin top bar, search for a screen and see what's grouped under Company, Commerce, Payments and System. Settings holds your company's configuration in the Fluid admin, from agreements and branding to checkout, taxes, payment options and webhooks. ## Where to find it In the admin, click the **Settings** gear in the top bar. Settings opens full screen on the **Agreements** screen. ## What's on the screen * The sidebar on the left starts with a **Settings** heading and a **Search...** box, followed by the Settings screens listed under **Company**, **Commerce**, **Payments** and **System**. * The header runs across the top of each screen. On a desktop it shows a breadcrumb that starts with **Settings** and ends with the screen's name. On the right are that screen's actions, such as **Save**, and the **X** that closes Settings. * The main area shows the options for the screen you selected. On a phone, the sidebar is hidden and the header shows the screen's name instead of a breadcrumb. Tap the menu button at the top left of the screen to open the sidebar, then tap a screen to open it. The name in the header doesn't always match the sidebar label. For example, **Gateways** opens as **Payment Gateways**. ### Screens in each group Your list may differ: you see only the screens your role can view, and some screens appear only for companies that use them. Screens without a link don't have a Help Center page. | Group | Screens | | - | - | | **Company** | [Agreements](/help/admin/settings/agreements), [Brand Guidelines](/help/admin/settings/brand-guidelines), [Catchups](/help/admin/settings/catch-ups), [Communications](/help/admin/settings/communications), [Default Mysite](/help/admin/settings/default-mysite), Entities, [Fair Share](/help/admin/settings/fair-share), [Languages](/help/admin/settings/languages), [Onboarding](/help/admin/settings/onboarding), [Roles](/help/admin/settings/roles), Login & Identity, [Social Media](/help/admin/settings/social-media) | | **Commerce** | [Cart](/help/admin/settings/cart), [Checkout](/help/admin/settings/checkout), [Countries](/help/admin/settings/countries), Customers, [Floating Action Buttons](/help/admin/settings/floating-action-buttons), Member Types, [Metadata Definitions](/help/admin/settings/metadata-definitions), Points, Ranks, [Shipping](/help/admin/settings/shipping), [Subscription Plans](/help/admin/settings/subscription-plans), [Taxes](/help/admin/settings/taxes), [Warehouse](/help/admin/settings/warehouses) | | **Payments** | AI Spend, [APM](/help/admin/settings/apm), Billing, Gateways, Payment Routing | | **System** | API Tokens, [Callbacks](/help/admin/settings/callbacks), Databases, Developer, [Domains](/help/admin/settings/domains), Drop Zones, Global Embeds, Mist Apps, [Webhooks](/help/admin/settings/webhooks) | Webhook logs don't have their own sidebar entry. Open **Webhooks** and select **View Webhook Logs**, or see [Webhook logs](/help/admin/settings/webhook-logs). ## Find a screen On a desktop, type part of a screen's name in the **Search...** box under the **Settings** heading in the sidebar. The cursor is already in the box when Settings opens. The sidebar narrows to the matching screens and hides any group with no match. Select a screen to open it in the main area. Search matches screen names only, not the options inside a screen. ## Close Settings Select the **X** at the top right of the screen, or press **Esc**. The admin returns to the page you had open before you opened Settings. If you opened Settings from a bookmark, reloaded the page while in Settings, or opened webhook logs with **View Webhook Logs**, the admin opens **Getting Started** instead. On a screen with a **Save** button in the header, leaving the screen doesn't save your changes. Select **Save** before you select another screen, select the **X** or press **Esc**. If a drawer or dialog is open, close it with its own buttons, not **Esc**. ## Frequently asked questions For your company's options, click the **Settings** gear in the top bar. For your own profile, close Settings, then select your name or picture at the bottom of the admin's main sidebar and select **Profile**. On a phone, tap the menu button at the top left of the admin first to open the main sidebar. Ask an admin who manages roles to check that your role can view it. See [Roles](/help/admin/settings/roles). ## Related pages * [Admin portal](/help/admin) * [Roles](/help/admin/settings/roles) * [Getting help](/help/getting-help)