> ## 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. # Connect a custom domain to a Mist app > Serve a Mist app at a domain you own: add the domain, create the DNS records Mist shows, and re-check until it's live. Every Mist app has its own address on a Fluid-hosted domain, with HTTPS. You can also serve it at a domain you own, such as `events.dundermifflin.com`. This page is about a Mist app's domain. To connect a domain to your storefront and checkout, see [Set up a custom domain](/setup/custom-domain). The `fluid domains` CLI commands manage storefront domains only. ## Before you start * You need access to the DNS settings for the domain, at your registrar or DNS provider. * The app must be set up. While it's still provisioning, adding a domain fails. * Through the API, your token needs the `mist.env_vars` permission. ## Connect a domain ### In the Mist desktop app Right-click the Mist app and click **Domain**. Under **Add a domain**, enter the full domain, such as `events.dundermifflin.com`, and click **Add domain**. Mist shows each record to create, with its **Type**, **Name** and **Value**. Click **Copy value** and create each record at your DNS provider exactly as shown. Click **Re-check verification**. Repeat until the domain shows **Live**. ### Through the API 1. [Attach a custom domain](/api-reference/mist_domains/attach-a-custom-domain). The response lists the DNS records to create. 2. Create the records at your DNS provider. 3. Call [Inspect a custom domain](/api-reference/mist_domains/inspect-a-custom-domain) until the domain is verified and no longer misconfigured. The CLI has no command for Mist app domains yet. ## The DNS records You may see two kinds of record: * **Verification record**: a `TXT` record that proves you own the domain. Mist shows it when the domain needs one. * **Routing record**: points the domain at the app. A subdomain, such as `events.dundermifflin.com`, usually uses a `CNAME`. A root domain, such as `dundermifflin.com`, usually uses an `A` record. Always use the exact type, name and value Mist shows for your domain. If a record already exists for the same name, replace it rather than adding a second one. ## What the status means | Status | What it means | What to do | | - | - | - | | **Pending verification** | Fluid can't confirm you own the domain yet. | Add the verification record, then re-check. | | **Needs DNS routing** | You own the domain, but it doesn't point at the app yet. | Add the routing record, then re-check. | | **Live** | The domain is verified and points at the app. | Nothing. | | **Status unknown** | Mist couldn't check the domain's routing. | Re-check in a moment. If the domain doesn't load, add the records shown. | DNS changes can take from a few minutes to a few hours to reach everyone. ## Remove a domain In the **Domain** dialog, click **Remove domain** next to the domain, then confirm. The app stops responding at that domain, and keeps working at its Fluid address. You can add the domain again later. Through the API, use [Detach a custom domain](/api-reference/mist_domains/detach-a-custom-domain). ## Troubleshooting Check that the `TXT` record's name and value match what Mist shows, character for character. Some DNS providers add your domain to the end of every name for you. If yours does, enter only the part of the name before your domain. Look for an older record on the same name, such as an `A` record left from a previous site, and remove it. A name can't have a `CNAME` and other records at the same time. A domain can belong to only one app. If it's already attached to another Mist app, remove it there first. If the app is still being set up, wait until it's live. ## Related pages * [Mist Apps](/help/mist/mist-apps#connect-a-domain) in the Help Center * [Troubleshooting](/mist-apps/troubleshooting) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.