> ## 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. # The theme's member sites, each with its pages > Returned in the order a resolver considers them, so the builder's panel and the storefront agree about precedence without the client sorting. Pages come nested, so drawing a folder takes one request. ## OpenAPI ````yaml /api-reference/theme-surfaces-v0.yaml get /api/company/members_sites openapi: 3.1.0 info: title: Fluid Theme Surfaces API version: v0 description: >- The admin seam over a theme's release lifecycle. A release freezes the theme's currently-resolved bindings into an immutable artifact; activating one is what the storefront and the member account zone then serve, and rolling back moves that pointer rather than re-rendering anything. Every operation resolves the theme from the authenticated company. No operation accepts a theme id, so a release cannot be published onto, or activated for, another merchant's theme by supplying one. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: - bearer_auth: [] tags: - name: theme-surfaces description: Routable slots and the templates bound into them - name: theme-audiences description: Who sees which structure - name: theme-releases description: Publish, activate and roll back a theme's releases - name: members-sites description: >- The storefront Members scope's sites: an access rule and the page set it governs, as a builder edits them - name: members-pages description: The pages inside a member site, as a builder edits them paths: /api/company/members_sites: parameters: - name: application_theme_id in: query required: false description: >- Company-owned theme being edited, including draft themes. Omit for the active theme. Unknown or foreign themes return 404 without falling back. schema: type: integer minimum: 1 get: tags: - members-sites summary: The theme's member sites, each with its pages description: >- Returned in the order a resolver considers them, so the builder's panel and the storefront agree about precedence without the client sorting. Pages come nested, so drawing a folder takes one request. operationId: theme_surfaces_v0_list_members_sites responses: '200': description: The theme's member sites, in resolution order content: application/json: schema: $ref: '#/components/schemas/MembersSiteList' example: members_sites: - id: 6021 name: Reps active: true default: false position: 1 layout_name: theme menu_slug: reps-navigation menu_id: 4417 unconstrained: false rule: country_ids: - 214 member_type_ids: - 0191d3f0-7c2a-7b4e-9d61-3f8a2c5e1b07 pages: - id: 81530 title: Rewards slug: rewards published: true path: /accounts/rewards template_id: 55102 updated_at: '2026-09-18T14:03:27Z' - id: 6018 name: Everyone active: true default: true position: 2 layout_name: member menu_slug: everyone-navigation menu_id: 4409 unconstrained: true rule: country_ids: [] member_type_ids: [] pages: - id: 81502 title: Welcome slug: / published: true path: /accounts template_id: 55090 updated_at: '2026-09-02T09:41:12Z' system_screens: - key: messaging label: Messaging path: /accounts/messaging - key: contacts label: Contacts path: /accounts/contacts - key: my-site label: My Site path: /accounts/my-site - key: profile label: Profile path: /accounts/profile - key: orders label: Orders path: /accounts/orders - key: subscriptions label: Subscriptions path: /accounts/subscriptions '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: schemas: MembersSiteList: type: object additionalProperties: false required: - members_sites - system_screens properties: members_sites: type: array items: $ref: '#/components/schemas/MembersSite' system_screens: type: array description: >- The screens Fluid ships, sent once rather than nested in each site. Every site has every screen, so nesting would repeat the catalogue and imply a per-site variation that does not exist. Absent from the create and update responses for the same reason: a site just created has the same screens as every other. items: $ref: '#/components/schemas/SystemScreen' MembersSite: type: object description: >- An access rule and the page set it governs, scoped to one theme. The rule is a permission, not a presentation choice: a member who does not match a site cannot reach its pages, and requesting one returns 404. That is what separates a site from an audience. additionalProperties: false required: - id - name - active - default - position - layout_name - menu_slug - menu_id - unconstrained - rule - pages properties: id: type: integer name: type: string description: What the merchant calls the site, unique within the theme. examples: - Reps active: type: boolean description: An inactive site resolves for nobody, without deleting its pages. default: type: boolean description: >- Whether this site is the fallback, considered only after every explicit site has failed to match. Not the same as sorting last: a fallback matches everybody, so ordering one above an explicit site would otherwise swallow it. layout_name: type: - string - 'null' description: >- The `layouts` template a site's pages are framed in, by name — a theme travels as a zip and an id means nothing in the company importing it, which is why `{% layout %}` has always named one. `"none"` means deliberately no layout. Null only for a site that predates the field; a site created through this API carries the theme's default explicitly. examples: - theme menu_slug: type: - string - 'null' description: >- The menu this site is navigated by, by slug — a theme travels as a zip and an id means nothing in the company importing it. Null for a site created before menus or one whose menu was deleted, in which case the storefront derives navigation from the site's pages, so null means "derived" rather than "no navigation". Read-only: a site is given its menu when it is created. examples: - reps-navigation menu_id: type: - integer - 'null' description: >- The same menu by id, so a client can open it without resolving the slug first. Null whenever `menu_slug` is, and also when the slug names a menu that no longer exists. examples: - 42 position: type: integer description: >- Ascending, and contiguous from 1 across the theme's sites. Within the explicit group, and within the default group, the first site whose rule matches wins. Sending a `position` to the update endpoint moves the site and renumbers the rest, so this value is never duplicated. unconstrained: type: boolean description: >- Whether the rule constrains nobody and so matches everyone. Derived by the server because the empty-axis rule is the most misread thing in this model, and two clients computing it is two chances to invert it. rule: $ref: '#/components/schemas/MembersSiteRule' pages: type: array description: >- The pages this site governs, nested rather than sent as a flat list keyed by site id. A page's audience *is* its site, so a page outside one has no meaning. items: $ref: '#/components/schemas/MembersPage' SystemScreen: type: object description: >- One screen Fluid ships for member sites. Not a page a merchant composes: its body is a single custom element from the member SDK, so there are no sections, nothing to edit, and no template to open. Every site has every screen and always has, which is why there is no id — a screen has no record, and the key is its identity. A client draws these in a site's page list as required and locked, and offers them in a navigation picker, but must never draw one as an editable page. additionalProperties: false required: - key - label - path properties: key: type: string description: The screen's identity, stable across companies and releases. examples: - messaging label: type: string description: What a merchant sees in the page list and the link picker. examples: - Messaging path: type: string description: >- The storefront path the screen serves at. Fixed by Fluid, so a merchant cannot move it, and the whole of a menu item pointing at one: with no record to reference, a URL is the only link there is. examples: - /accounts/messaging AuthError: type: object description: >- The shared API authentication and authorization refusal, which carries a message and no machine-readable code. Described as the framework actually answers rather than as this API would have chosen, because neither status is produced by this controller. additionalProperties: true required: - message properties: message: type: string Error: type: object additionalProperties: false required: - error - message properties: error: type: string message: type: string details: type: object additionalProperties: true MembersSiteRule: type: object description: >- What a site constrains. An empty array means **unconstrained**, not "matches nothing", so a rule with both axes empty matches everybody and clearing an axis widens the site rather than narrowing it. A client that sends `[]` to mean "nobody" will publish a site that matches everyone. additionalProperties: false required: - country_ids - member_type_ids properties: country_ids: type: array description: >- Country ids, empty meaning any country. Numbers, because countries are bigint-keyed; member type ids are strings because theirs are uuids. items: type: integer examples: - - 1 member_type_ids: type: array description: Member type ids, empty meaning any member type. items: type: string examples: - - 0191d3f0-0000-7000-8000-000000000000 MembersPage: type: object description: >- One page inside a member site. Enough to draw a row in the builder's folder and open it. The slug is unique within its site, not globally, so two sites may both hold `rewards` and the member decides which they get. additionalProperties: false required: - id - title - slug - published - path - template_id - updated_at properties: id: type: integer title: type: string description: What the merchant calls the page. examples: - Rewards slug: type: string description: >- The path segment, unique within this site. Use / for the home page; system routes are reserved. examples: - rewards published: type: boolean description: >- Whether members see it. A draft is absent from navigation and 404s when requested, rather than rendering an unfinished page. path: type: string description: The storefront path this page serves at. examples: - /accounts/rewards template_id: type: - integer - 'null' description: >- The template the visual builder opens. Created and bound with the page, because the builder addresses a page by its template — one with no template is a row a merchant cannot click. Nullable only for pages that predate that, or whose template was deleted outside the builder. updated_at: type: string format: date-time responses: Unauthorized: description: No or invalid credentials content: application/json: schema: $ref: '#/components/schemas/AuthError' Forbidden: description: Authenticated, but not permitted to manage themes content: application/json: schema: $ref: '#/components/schemas/AuthError' NotFound: description: The company has no active theme, or no such release content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````