> ## 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 <token>; 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 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 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.

# Read Droplet data in a Portal widget

> Use the built-in typed Portal function for signed, member-specific Droplet reads.

## Use the built-in Portal function

A Portal widget runs in a worker. Import `queryDropletData` from `@fluid-app/portal-sdk/widgets/worker` and declare the same function in the widget's `uses` array. Once the matching SDK and Portal backend are deployed, the standard `FluidProvider` wires the transport automatically; you do not need a custom host function or access to the host project for this query.

<Warning>
  Use an SDK release that actually exports `queryDropletData` and a Portal deployment that supports the bound Droplet query context. Confirm the installed SDK actually exports the function and the deployed host/backend support it; do not infer availability from a source merge or guess a minimum version. An older host/backend without the context proof is unavailable; do not fall back to direct worker fetch or an unbound request.
</Warning>

The function declares capability `dropletData` version `1`, method `query`. Adding `uses` does not grant access by itself. Build and publish the package, then add its current widget in the Portal screen builder. The existing permission dialog shows the publisher, package version and requested permissions; choose **Allow capabilities** to approve insertion, or **Cancel** to stop. Save and publish the intended screen when ready; that changes the screen configuration. An existing placement with a stale package-version grant is not automatically approved: remove and re-add the current widget, approve its capabilities, then save/publish. Do not hand-edit security grant JSON or invent another approval flow. If Mist cannot access the builder, report this authoring prerequisite. See [build and publication](/portal-widgets/widget-packages/build-and-publish).

## Configure the Droplet once

Register the Droplet with its required `name` and `embed_url`, configure its canonical `data_url`, and install it in the member's company. Copy the public `uuid` returned by the management API, such as `drp_acme_rewards`; do not use a database UUID or guess an identifier. Read the authorized management response back and confirm `data_url` equals the intended receiver URL before proceeding: an older deployment may ignore an unknown field. `widget_data_url` remains a deprecated compatible alias, not another destination. See [registration and receiver setup](/themes/member-storefront/droplet-data#register-the-destination-and-save-the-secret).

The Droplet must be available, operational, and actively installed. UUID queries do not require a theme extension or a member storefront site. The Portal requires its own signed-in session and an active native member in the trusted company. Do not assume that a draft label or presentation `active: false` alone prevents the owner company's authorized testing; verify installation and actual query availability. Keep the Droplet secret on the receiver server.

## Call from the worker

The public signature is `queryDropletData({ dropletUuid, operation, params? })`, returning a promise of JSON. `params` is a JSON object; validate your application's response shape before rendering. The operation name is application-defined: `member.echo` below works only after you implement that receiver operation. Replace the example Droplet identifier with the actual management response's public `uuid`.

```js title="member-echo-widget.js" theme={null}
import { createElement, useEffect, useState } from "react";
import { defineWidget, queryDropletData } from "@fluid-app/portal-sdk/widgets/worker";

export function MemberEchoCard() {
  const [text, setText] = useState("Loading member…");
  useEffect(() => {
    let current = true;
    setText("Loading member…");
    queryDropletData({ dropletUuid: "drp_acme_rewards", operation: "member.echo", params: {} })
      .then(result => {
        const member = result && typeof result === "object" && !Array.isArray(result) ? result.member : null;
        if (!member || typeof member.id !== "string" || typeof member.public_id !== "string" ||
            !(member.external_id === null || typeof member.external_id === "string")) {
          throw new Error("Unexpected Droplet result");
        }
        if (current) setText(JSON.stringify({ id: member.id, public_id: member.public_id, external_id: member.external_id }, null, 2));
      })
      .catch(() => { if (current) setText("Member data is unavailable"); });
    return () => { current = false; };
  }, []);
  return createElement("pre", { role: "status" }, text);
}

export const memberEchoWidget = defineWidget({
  name: "MemberEcho",
  component: MemberEchoCard,
  uses: [queryDropletData],
});
```

Add `memberEchoWidget` to your package's existing widgets array and use its normal generated worker entry. The example projects the three approved member fields and renders their JSON as text, handles malformed/rejected results, and ignores a pending component continuation after unmount. Do not persist private results in local storage or a cross-session cache.

The standard host owns the signed Portal cookie, fresh CSRF token and opaque session proof. It binds the dated same-origin Portal query to the current context and discards stale replies; a changed context hides and disposes affected consuming workers. Preview or missing proof is controlled unavailability. This is not an instantaneous server-push revocation guarantee. The worker never handles credentials, proof headers, the Droplet secret or host DOM, and does not call the Portal endpoint with `fetch`.

Errors are `PortalFunctionError` values, including invalid arguments, undeclared use, missing approval and unavailable transport. Show a recoverable unavailable state and correct the actual declaration, approval or deployment; never retry with a different identity or bypass the host. Keep upstream diagnostics server-side. See [portal function errors](/portal-widgets/widget-packages/portal-functions#handle-errors-and-partial-data).

## Implement a read-only receiver

At `data_url`, verify the exact raw bytes using the Droplet secret and `verifySignature` from `@fluid-app/droplet-sdk`, including timestamp freshness, before parsing JSON. Verify the signed company/shop binding and authorize the read. Follow the [raw-body verification example](/themes/member-storefront/droplet-data#verify-the-raw-body); do not reserialize JSON before verification.

For `member.echo`, require empty `params` and return `{ member: query.member }` from the **verified signed payload**, unchanged. Do not fabricate member fields, trust a member identifier from `params`, or fetch another member to construct the echo. Reject other operations and malformed identity objects. Keep this operation read-only and return only the member fields the signed payload already authorizes; do not log the payload or secret.

A Node receiver can implement the echo after checking the raw signature as follows. `request` is the incoming Web `Request`; supply `FLUID_DROPLET_SECRET` from the receiver's server-only secret storage. This example performs no backend write or member lookup.

```js title="member-echo-receiver.js" theme={null}
import { verifySignature } from "@fluid-app/droplet-sdk";

export async function receiveMemberEcho(request, secret) {
  if (!secret) return new Response("Receiver is not configured", { status: 503 });
  const rawBody = Buffer.from(await request.arrayBuffer());
  const verified = verifySignature({
    rawBody, secret,
    timestamp: request.headers.get("x-fluid-timestamp"),
    signature: request.headers.get("x-fluid-signature"),
  });
  if (!verified.valid) return new Response("Invalid signature", { status: 401 });
  let query;
  try { query = JSON.parse(rawBody.toString("utf8")); }
  catch { return new Response("Invalid JSON", { status: 400 }); }
  const member = query?.member;
  if (!Number.isInteger(query?.company?.id) || query.company.id <= 0 ||
      !query.company.fluid_shop || query.company.fluid_shop !== request.headers.get("x-fluid-shop") ||
      !member || typeof member.id !== "string" || typeof member.public_id !== "string" ||
      !(member.external_id === null || typeof member.external_id === "string") ||
      query.operation !== "member.echo" || !query.params || Array.isArray(query.params) ||
      typeof query.params !== "object" || Object.keys(query.params).length !== 0) {
    return new Response("Unsupported query", { status: 422 });
  }
  return Response.json({ member: query.member }, { headers: { "Cache-Control": "private, no-store" } });
}
```

## Give Mist a complete task

> Build a Portal widget using the built-in `queryDropletData` function, declared in `uses`, with my installed Droplet's public UUID. Follow the Portal Droplet data guide. Implement the read-only `member.echo` receiver and display the verified member's three approved identity fields as JSON text. Verify the SDK export, deployed Portal context support and package-version capability approval. Do not invent member data, a custom host bridge, a worker fetch, or a member-storefront client.

Before calling the integration complete, test two real member scopes, missing installation, missing/stale package approval, preview, unknown operation, signature/timestamp failure, and sign-out/account switch while a response is delayed. A stale reply must not render in the next scope. Test the deployed contract, not merely source merge status or successful asset downloads.

For other application-specific capabilities, a [custom typed portal function](/portal-widgets/widget-packages/portal-functions) can still be implemented by a host integrator. That advanced seam is not required for built-in Droplet reads and must not be used as an automatic fallback when this capability is unavailable.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.