> ## 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 confirmation link, then sign the agent in to the Fluid CLI or give it 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 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. # Copy a native widget into a theme > Gives one of the company's themes its own editable copy of a Fluid native widget, carrying the widget's source, settings and locales. The copy replaces the widget at every placement in that theme. Returns 201 with a new copy, or 200 with the copy the theme already has. Requires theme update permission and the native widget catalog; a company without the catalog gets 404. ## OpenAPI ````yaml /api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/native-widget-copies openapi: 3.1.0 info: title: Fluid Themes API description: | **The versioned themes surface.** Themes v0 (`/api/application_themes`) remains in place and unchanged — the theme editor and the Fluid CLI consume it and depend on its shape, including the heavy fields this version omits. That immovability is why this version exists: here the DEFAULT response is the lean one. Concretely, measured against production: - `GET /api/application_themes` returns the deprecated theme-level stylesheet columns on every row. For a three-theme company that is a 185KB response of which `global_stylesheet` alone is 182KB. - `GET /api/application_themes/active` renders every template with its Liquid `content`. On a 245-template theme that is 5.5MB, 96.5% of it template bodies, when callers typically need only `id`, `themeable_type` and `default` to resolve a single template. The path segment here is `themes`, not `application_themes`. **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v2026-04 contact: email: support@fluid.app servers: - url: https://api.fluid.app security: - bearer_auth: [] tags: - name: themes description: Theme listing and the active theme. - name: theme widgets description: >- A theme's own editable copies of Fluid's native widgets. A copy replaces the widget at every placement in its theme, and other themes keep Fluid's original. Deleting the copy as a template returns the theme to the original. x-fluid-section: Website - name: preview comments description: |- Comments pinned to an element on a theme's preview, and their replies. A comment is addressed by the client-generated `client_id` rather than a row id: that is the identity every client already holds, so a retry after a dropped response is the same request rather than a new one. Creating a comment or a reply twice under one id is a success that changes nothing. There is one route per operation rather than a single write of the whole comment set. `status` is a last-writer-wins register keyed on `status_at_ms`, so a write carrying an older stamp than the stored one is accepted and discarded — it answers 200 with the status unchanged, because the request did what the contract says. paths: /api/v202604/themes/{theme_id}/native-widget-copies: post: tags: - theme widgets summary: Copy a native widget into a theme description: |- Gives one of the company's themes its own editable copy of a Fluid native widget, carrying the widget's source, settings and locales. The copy replaces the widget at every placement in that theme. Returns 201 with a new copy, or 200 with the copy the theme already has. Requires theme update permission and the native widget catalog; a company without the catalog gets 404. operationId: createThemeNativeWidgetCopy parameters: - name: theme_id in: path required: true description: Company-owned theme that receives the copy. schema: type: integer minimum: 1 requestBody: required: true content: application/json: schema: type: object required: - native_widget_key properties: native_widget_key: type: string minLength: 1 description: >- Key of the native widget to copy, as in a template's `native_widget_key`. example: native_widget_key: earnings responses: '200': description: The copy the theme already has. content: application/json: schema: $ref: '#/components/schemas/NativeWidgetCopyResponse' example: template: id: 902377 name: fluid_native_earnings themeable_type: sections status: draft application_theme_id: 48213 company_id: 1405 global: false source: theme native_widget_key: null native_widget_uri: null customized_native_widget_key: earnings status: 200 meta: request_uuid: 4d8e1b63-7a2c-4f95-8e07-c3b6a9d2f150 timestamp: '2026-10-20T16:41:12Z' '201': description: The theme's new copy of the native widget. content: application/json: schema: $ref: '#/components/schemas/NativeWidgetCopyResponse' example: template: id: 902377 name: fluid_native_earnings themeable_type: sections status: draft application_theme_id: 48213 company_id: 1405 global: false source: theme native_widget_key: null native_widget_uri: null customized_native_widget_key: earnings status: 201 meta: request_uuid: 9b2f4c71-3e8a-4d06-b5c9-1a7e2f6d8c43 timestamp: '2026-10-20T16:40:56Z' '401': description: Missing or invalid admin credential. content: application/json: schema: type: object required: - message properties: message: type: string '403': description: Credential lacks company administration or theme update permission. content: application/json: schema: type: object required: - message properties: message: type: string '404': description: >- The theme is not the company's, the native widget does not exist, or the native widget catalog is off. content: application/json: schema: $ref: '#/components/schemas/NativeWidgetCopyError' '422': description: >- The native widget key is missing, or the theme belongs to a theme branch and changes only through branch publication. content: application/json: schema: oneOf: - $ref: '#/components/schemas/NativeWidgetCopyError' - $ref: '#/components/schemas/BranchThemeRefusal' security: - bearer_auth: [] components: schemas: NativeWidgetCopyResponse: type: object required: - template - status - meta properties: template: $ref: '#/components/schemas/ThemeTemplate' status: type: integer enum: - 200 - 201 meta: type: object NativeWidgetCopyError: type: object description: Native widget copy failure. required: - error - status - meta properties: error: type: object required: - message - details properties: message: type: string details: type: object status: type: integer meta: type: object BranchThemeRefusal: type: object description: >- The theme belongs to a theme branch, so it changes only through branch publication. required: - error_message - errors - meta properties: error_message: type: string errors: type: object meta: type: object ThemeTemplate: type: object description: >- A template including its Liquid content. Native and droplet widget sections expose metadata and settings only; content contains only the declarative settings schema. properties: native_widget_key: type: - string - 'null' description: Trusted Fluid native widget identity. native_widget_uri: type: - string - 'null' description: Stable Fluid native widget placement reference. customized_native_widget_key: type: - string - 'null' description: >- The native widget this theme's own copy replaces at every placement in the theme; null for other templates. id: type: integer name: type: - string - 'null' content: type: - string - 'null' themeable_type: type: - string - 'null' status: type: - string - 'null' default: type: - boolean - 'null' variables: type: - object - 'null' additionalProperties: true description: Template-level Liquid variables. translations: type: - object - 'null' additionalProperties: true application_theme_id: type: - integer - 'null' company_id: type: - integer - 'null' app_extension_id: type: - integer - 'null' extension_uri: type: - string - 'null' droplet_name: type: - string - 'null' source: type: - string - 'null' global: type: - boolean - 'null' country_ids: type: - array - 'null' items: type: integer hide_navbar: type: - boolean - 'null' use_active_application_theme: type: - boolean - 'null' stylesheet: type: - string - 'null' stylesheet_tag_injected: type: - boolean - 'null' stylesheet_column_hidden: type: - boolean - 'null' created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - id securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.