> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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. > To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. A Site can serve light server code: each functions/.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/ on the Site's own host; publish it with fluid deploy (the MCP site_deploy tool does not carry functions). See /sites/functions and /sites/rest-api. > 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. # Change a share > Changes the permission of a share of a site, whether it pins the site, or both, and nothing else. To change who a share names, delete it and add another. A share of a member's site is changed by a company admin who holds a kept admin row, and refused with 404 to a root admin who holds none and when the site's owner was discarded. Needs `application_themes.update` and a signed-in admin. ## OpenAPI ````yaml /api-reference/company-member-sites-v2026-10.yaml patch /api/company/v2026-10/member-sites/{id}/shares/{share_id} openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Member Sites description: > How company admins oversee member sites: every site in the company, whether the company or one of its members owns it. Admins create and change company sites, take any site down so its owner cannot publish it again, delete any site with its pages, and copy any site into a new company site. An admin also builds a company site as a member builds their own: its files and pages are written, and the site is published, through the routes below. A company admin who holds a kept admin row also changes, publishes and writes the files and pages of a member's site, as its owner does. A root admin who holds no admin row only oversees a member's site: list, read, take down, delete and copy; its files, pages, publishing and changes are refused with 403. An admin also sees and manages who a site is shared with. The shares of any site in the company are listed and deleted here, and the shares of a company site are created and changed, and so are the shares of a member's site, by an admin who holds a kept admin row (a root admin with none is refused with 404); sharing with a member's downline is refused with 422. A share names its audience by name and never by email address. No route lists the sites members removed from their own menus. An admin also features sites. A featured site is listed first, in the company's order, in the menu of every member it is shared with; featuring a site shares it with no one, and writes nothing to the site, so a member's site keeps its version and its history. A draft, a taken-down site, a discarded owner's site and a branch are not featured. A company features at most 20 sites. A signed-in admin is needed to feature, unfeature or order them, and a credential with no user can list them. A site is addressed by its `id`, which is its `uuid_v7`. The owner of a member site is summarized by the member's id and display name; no contact details are returned. A signed-in admin needs the `application_themes.view` permission to read and `application_themes.update` to write, the permissions the theme endpoints use. A droplet installation token reads with the `website` scope, which droplet authentication grants for the theme permissions; on a sandbox twin it gets the owner's display name as null. Every route also needs the `MEMBER_SITES` company flag, and a company without it gets 404 on every route. Writes act as the signed-in admin, so a credential with no user, such as a company API token or a droplet token, can read sites and the pages of a company site, but not write; a company API token can also read the shares of a site, which a droplet token never can: a share names members, so every share route answers a droplet token, and an OAuth client token whatever its scopes, with 403. Files, which hold a site's code, are read through the signed-in admin too: such a credential gets 403 on them. An admin also sees and manages a site's branch: a private copy of a published site, made to try a change, that only its owner and company admins can open. The branch of any site in the company is listed, read, created and deleted here. A company admin who holds a kept admin row branches a member's site as its owner would: the branch is the owner's, and the admin is recorded as its creator. Branching a member's site is refused with 404 to a root admin who holds no kept admin row. A branch is a site of its own, left out of the site list, whose files, pages and publishing are served here as its parent's are. A credential with no user, such as a company API token, can read branches but not write them. Once member sites are enabled for the company, every branch route answers a droplet token, and an OAuth client token whatever its scopes, with 403. While they are not enabled the route answers 404 first to a droplet token with the `website` scope and to an OAuth client token with the scopes the route needs, as it does to every other credential; a token without those scopes is refused with 403 either way. The preview routes show a company site's draft to the admin who builds it, through the same renderer that serves the site's published pages. They answer with a page's HTML or a file's text, not the JSON envelope, and need a signed-in admin with `application_themes.view`. Every response of theirs, a refusal included, carries the frame's sandbox policy and is `private, no-store` and `noindex`. An Identity client token is refused with 403 on them, whatever its scopes. A member's site is the same empty 404 as a missing one for a root admin who holds no kept admin row. version: 2026-10 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: - bearer_auth: [] tags: - name: member-sites description: Member sites in your company, for admins to oversee. x-fluid-section: Members - name: member-site-files description: >- The files of a site: layouts, sections, snippets, assets, page content, settings and menus. x-fluid-section: Members - name: member-site-pages description: The pages of a site. x-fluid-section: Members - name: member-site-shares description: Who a site is shared with. x-fluid-section: Members - name: member-site-branches description: The branch of a site, a private copy made to try a change. x-fluid-section: Members - name: member-site-bundles description: >- Publishing a company site as a built static bundle, uploaded straight to Cloud Storage with signed URLs. x-fluid-section: Members - name: member-site-builds description: >- Building a company site on Fluid from its source, files sent inline or a ref of its repo, and publishing the result as a bundle. x-fluid-section: Members - name: member-site-api-keys description: >- The API keys of a company site (`fsk_`), which a server or another site sends as `Authorization: Bearer` to call the site's `access: "key"` server functions. A key's secret is shown once, when it is added. x-fluid-section: Members - name: member-site-env-vars description: >- The environment variables of a company site, which its server functions read as `ctx.secrets`. A secret's value is never read back. x-fluid-section: Members - name: member-site-updates description: >- The short updates a company admin posts on a company site or a member's site, which every member whose menu lists the site gets on their bell. x-fluid-section: Members - name: member-site-hosting description: >- A company site's deployments, log and traffic: what was published and when, what happened, and who visited. x-fluid-section: Members - name: member-site-database description: Downloading a site's database as a DumpV1 file. x-fluid-section: Members - name: member-site-data description: >- An admin's read and delete of the rows of a site's database. Rows are never inserted or changed here. x-fluid-section: Members - name: member-site-features description: >- The sites the company features, so the members they are shared with see them first. x-fluid-section: Members - name: member-site-home description: The company site a member with no home of their own lands on. x-fluid-section: Members - name: member-site-policy description: >- The scopes the company's rep sites may use on a visitor's data, and the caps it has raised on its sites' databases. x-fluid-section: Members - name: member-site-conversion description: >- Turning a public company site into a Mist app, and the rule that says whether a new project should be a site or an app. x-fluid-section: Members - name: member-site-preview description: >- The draft of a company site, rendered as it will be served once published, for its builder's own tools. x-fluid-section: Members paths: /api/company/v2026-10/member-sites/{id}/shares/{share_id}: patch: tags: - member-site-shares summary: Change a share description: >- Changes the permission of a share of a site, whether it pins the site, or both, and nothing else. To change who a share names, delete it and add another. A share of a member's site is changed by a company admin who holds a kept admin row, and refused with 404 to a root admin who holds none and when the site's owner was discarded. Needs `application_themes.update` and a signed-in admin. operationId: companyMemberSiteSharesUpdate parameters: - $ref: '#/components/parameters/SiteId' - $ref: '#/components/parameters/ShareId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MemberSiteShareUpdateBody' example: member_site_share: permission: copy responses: '200': description: The changed share. content: application/json: schema: $ref: '#/components/schemas/MemberSiteShareResponse' example: member_site_share: id: 019a3d4e-6f70-7a81-9b92-a3b4c5d6e7f8 audience_kind: member member: id: 019a1111-2222-7333-8444-555566667778 name: Nathan Rivera member_type: null country: null label: Nathan Rivera permission: copy pinned: false created_at: '2026-10-15T09:30:00Z' status: 200 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-10-23T14:06:40Z' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The caller lacks the permission, has no signed-in admin, or is a droplet installation token, which is refused on every share route whatever its scopes. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthorizationError' - $ref: '#/components/schemas/ErrorResponse' '404': $ref: '#/components/responses/NotFound' '422': description: An empty body, or an unknown permission or field. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: SiteId: name: id in: path required: true description: The site's id. schema: type: string format: uuid ShareId: name: share_id in: path required: true description: The share's id. schema: type: string format: uuid schemas: MemberSiteShareUpdateBody: type: object description: The new permission of a share, whether it pins its site, or both. required: - member_site_share additionalProperties: false properties: member_site_share: type: object additionalProperties: false minProperties: 1 properties: permission: type: string enum: - view - copy - edit description: What the share grants. pinned: type: boolean description: >- Whether the share pins the site in the menu of every member it matches. MemberSiteShareResponse: type: object description: One share. required: - member_site_share - status - meta properties: member_site_share: $ref: '#/components/schemas/MemberSiteShare' status: type: integer description: The HTTP status. meta: $ref: '#/components/schemas/Meta' AuthorizationError: type: object description: The body an authentication or permission refusal answers with. additionalProperties: true ErrorResponse: type: object description: A refusal in the standard envelope. required: - error - status - meta properties: error: type: object required: - message properties: message: type: string description: What went wrong. details: type: object additionalProperties: true description: The fields that were refused, with why. status: type: integer description: The HTTP status. meta: $ref: '#/components/schemas/Meta' MemberSiteShare: type: object description: One audience a site is shared with, and what it may do with the site. required: - id - audience_kind - member - member_type - country - label - permission - pinned - created_at properties: id: type: string format: uuid description: The share's id. audience_kind: type: string enum: - member - downline - segment description: >- `member` names one member, `downline` the downline of the member who shared the site, and `segment` the members of a member type, a country, both or, with neither, every member. member: oneOf: - $ref: '#/components/schemas/ShareMember' - type: 'null' description: >- The member a `member` share names; null for the other kinds, and for a member who has since been deleted. member_type: oneOf: - $ref: '#/components/schemas/ShareMemberType' - type: 'null' description: The member type a `segment` share names, or null for any type. country: oneOf: - $ref: '#/components/schemas/ShareCountry' - type: 'null' description: The country a `segment` share names, or null for any country. label: type: string description: >- Who the share opens the site to, in words, such as a member's name, `Downline of Riley Kim`, `Customer in United States` or `All members`. permission: type: string enum: - view - copy - edit description: >- `view` opens the site; `copy` lets the member copy it too; `edit` lets every member the share matches edit its drafts, but not copy it. A share is made `edit` directly, or by a member accepting an invitation to edit. created_at: type: string format: date-time description: When the share was made. pinned: type: boolean description: >- Whether the share pins the site in the menu of every member it matches, unless they removed it. Meta: type: object description: Response metadata included on every response body. required: - request_uuid - timestamp properties: request_uuid: type: - string - 'null' description: Request correlation identifier. timestamp: type: string format: date-time description: When the response was built. ShareMember: type: object description: The member a share names. No contact details are returned. required: - id - name properties: id: type: string format: uuid description: The member's id. name: type: - string - 'null' description: >- The member's name. Null for a droplet, OAuth bearer or identity client token reading a sandbox twin. ShareMemberType: type: object description: The member type a segment share names. required: - id - name properties: id: type: string format: uuid description: The member type's id. name: type: string description: The member type's name. ShareCountry: type: object description: The country a segment share names. required: - code - name properties: code: type: string description: The country's ISO 3166-1 alpha-2 code. name: type: string description: The country's name. responses: Unauthorized: description: Not signed in. content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' NotFound: description: >- No such site, file, page or share in this company, or member sites are not enabled for it. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearer_auth: type: http scheme: bearer description: >- A company admin credential for your company, or a droplet installation token with the `website` scope for reads, except on the share routes, which refuse a droplet token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.