> ## 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. > 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 where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > 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 — 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. # Getting around the app > Find your way around your company's app: the tab bar and More, Home and its widgets, catch-ups, the calendar, the Shop tab and the Dashboard. The app is built around a tab bar at the bottom of the screen and a **Dashboard** you open from **Home**. Other pages cover each area in detail. ## The tab bar The tab bar sits at the bottom of the screen and shows icons only. The selected tab's icon is filled in and shown in your company's color. Unless your company has set up its own tab bar, you see these tabs: * **Home** (house icon) and **Share** (grid icon) always appear. * **Messaging** (inbox icon), **Contacts** (two-people icon) and **Shop** (shopping-bag icon) appear when your company has turned them on. A badge on **Messaging** shows how many unread messages you have. A badge on **Shop** shows how many items are in your cart. Your company can set up its own tab bar instead. It chooses the tabs, their names, icons and order, and it can add tabs that open web pages inside the app. The first five items sit in the tab bar. The rest go under **More** (three-lines icon), which lists them by name. Tap an item to open it, and tap **More** again to get back to the list. ## Home **Home** shows your company's name at the top. Tap your profile picture there to open the [Dashboard](#the-dashboard-at-a-glance). Your company builds Home, so its layout varies. It may have tabs across the top, such as Media or Pages, and widgets such as these: * **Catch Up**: how many catch-ups you have, and the first few. Tap the widget to start at the first card, or tap a listed catch-up to start there. See [Catch-ups](#catch-ups). * An events widget: your upcoming events. The large version shows a week, where you tap a day to see its events. Tap the widget to open the [Calendar](#calendar). * **To-Do List**: your open to-dos. Tap the circle next to a to-do to complete it, or the plus icon to add one. Tap the widget to open your tasks, which [Contacts](/help/mobile/contacts) covers. * A leaderboard widget: the top of a leaderboard. Tap it to open the full leaderboard. * **Get Started**: a set of courses with your progress. Tap a course to open it. **View All** opens the course list. ### Learn If your company offers courses, Home also has a **Learn** tab, after your company's tabs. * Each course is a card. A video course shows its status, **Not Started**, **In Progress** or **Completed**, and how much of the video you've watched. * If your company sorts courses into categories, tabs at the top show **All** courses or one category. * Tap a course to open its page. A course's page shows its video or images, title and description. When you close a video, the app saves your place, and marks the course **Completed** if you watched to the end. An unfinished video continues where you left off. ## Catch-ups Catch-ups are cards that suggest what to follow up on, such as a contact's recent activity, new media, a new product or an overdue task. The first time you open them, three intro cards explain how they work: tap **Get Started** and follow them. ### Work through your catch-ups On **Home**, tap the **Catch Up** widget, or tap one of the catch-ups listed in it. The counter at the top shows how many cards are left. Use the card's buttons or reply box, described below. On a card about a contact, tap the contact's name at the top for options such as **View Profile**, **Call**, **Text**, **Email**, **Add Note** and **Create a Task**. Swipe right, or tap **Complete**, to mark the card as read. Swipe left, or tap **Skip**, to set it aside for now. **Undo**, at the top, brings back the previous card. After the last card, the "You're all caught up." message appears. Tap **Done**. ### What each card lets you do * **Contact activity**: the contact's recent messages, orders, cart activity, page views, reviews and smart-link clicks. The bottom of the card has one of these: * **Respond in Messages**, which opens your phone's messaging app, or your email app if the contact has no phone number. * A reply box with a send button. * A task form. Tap **Add Due Date** to pick a date, enter a **Task Title** and tap **Save Task**. * Your contact groups. Tap a group to add the contact to it, and tap it again to remove them. * **New or trending media**: tap **Copy Link** or **Share Link**. * **New training material**: tap **View Training Material** to open the course. * **New product**: the product's page. **Add to Cart** adds it and opens your cart. **Buy Now** goes to checkout. * **Upcoming event**: the event's dates, title and description. * **Product review**: rate each product from an order, write a review if you like, and tap **Submit Review**. * **Overdue task**: tap **Mark as Done**. * **Reactions, comments or video views on your media**, and **a new leaderboard leader**: the media or message, with a way to reply. * **Custom**: a button that opens a web page. Tap **Go Back** to close it. ## Calendar Tap an events widget on **Home** to open the **Calendar**. Its **Upcoming** and **Past** tabs list your company's events. Each event shows its date, title, the start of its description, its **Start** and **End** times, and its link and venue if it has them. A status may also show: **Starting Soon**, **In Progress** or **Event Concluded**. * **Join Event** opens the event's link in your browser. It works when the event has a link and is **Starting Soon** or **In Progress**. * **View Detail** opens the event's page, with the full description, the same details and any images. ### Share an event In the **Calendar**, tap **View Detail** on the event. The share icon is at the top right. * **Share Event** opens your phone's share options with the event's details. * **Copy Link** copies the event's link. It appears when the event has one. * **Copy Event Details** copies the event's details as text. * **Add to Calendar** adds the event to your phone's calendar. ## The Shop tab If your app has a **Shop** tab, your company builds its content, for example a Products tab. At the top, the search icon opens product search and the cart icon opens your cart. ### Find a product Tap the search icon, then type in **Search Products** or tap a collection or category under **Shop By**. Tap it again to show **All Products**. The filter icon filters and sorts the results. Tap a product to open its page. ### A product's page * Photos, the title and the price choices: **Buy Once**, and **Subscribe** (or **Subscribe and Save** when the subscription price is lower) with how often it's delivered. If there's more than one delivery plan, tap the frequency to choose another. * A picker for each option the product has, such as a size, then **Quantity** and **Total**. * **Product Description**. **Product Unavailable!** means you can't buy that option right now. At the top of the page, the share icon shares a link to the product and the cart icon opens your cart. **Add to Cart** adds the selected option and quantity to your cart. **Buy Now** adds it and opens checkout. For a bundle, **Purchase on Website** opens the bundle's web page instead. ### Review and place your order Tap the cart icon on the **Shop** tab or on a product's page. The **Review Cart** screen opens. Each item shows **One Time** or **Subscription** and its price. Tap plus or minus to change the quantity. At a quantity of 1, the minus button becomes a trash icon that removes the item. To make an item a subscription, check **Subscribe** and choose its **Deliver Frequency**. If there's a **Promo Code** field, enter your code and tap **Apply**. To remove a code, tap the x on it. Review the **Subtotal**, **Discount**, **Tax**, **Shipping** and **Estimated Total**, then tap **Proceed to Checkout**. Checkout opens inside the app. Follow its steps to place your order. **Share Cart** sends someone a link to a copy of your cart, with the same items and promo codes, through your phone's share options. Your own orders and subscriptions are on the Dashboard. See [Settings and troubleshooting](/help/mobile/settings). ## The Dashboard at a glance Tap your profile picture at the top of **Home** to open the **Dashboard**. From top to bottom: * [**Notifications**](/help/mobile/settings#choose-your-notifications), the bell icon * [**Organization**](/help/mobile/settings#switch-organizations), if you belong to more than one company * Your business card, with a QR code * [**MySite**](/help/mobile/my-site), if you have one * [**My Uploads**](/help/mobile/playlists#my-uploads) and [**My Playlists**](/help/mobile/playlists) * [**Profile**](/help/mobile/settings#edit-your-profile) * [**Recent Activity**](/help/mobile/sharing#track-engagement-in-recent-activity) * [**Orders**](/help/mobile/settings#orders) and [**Subscriptions**](/help/mobile/settings#subscriptions), when your company shows orders * [**Language**](/help/mobile/settings#change-the-language), [**Get Help**](/help/mobile/settings#get-help), [**Account**](/help/mobile/settings#manage-addresses-and-payment-methods), [**General Information**](/help/mobile/settings#general-information) and [**Log Out**](/help/mobile/settings) To refresh a list, such as **Learn**, the **Calendar**, product search or your cart, pull down on it. ## Frequently asked questions Your company chooses which tabs appear, what they're called and their order. If your app has more than five, the rest are under **More**, the three-lines icon at the end of the tab bar. The widget opens only when you have catch-ups. When you have none, it shows "You're all caught up." No. **Complete**, or a swipe right, only marks the card as read. To act on the card, for example to reply or to add a product to your cart, use the card's buttons or reply box first. Yes. Tap **Undo** at the top of the screen to bring back the previous card. ## Related pages * [Mobile app](/help/mobile) * [Sharing content](/help/mobile/sharing) * [Messaging](/help/mobile/messaging) * [Contacts](/help/mobile/contacts) * [Settings and troubleshooting](/help/mobile/settings) * [Getting help](/help/getting-help) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.