> ## 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. # shows a droplet > Retrieve a droplet by its `uuid`. What you see depends on who you are: - Any company with the `droplets.view` permission can view a droplet it can see — a published droplet, one it owns, or one it was granted access to — along with its `owner_company`. - The owner company also gets its webhook URLs, `widget_data_url`, and `lifecycle_contract_version`. - A Fluid root administrator can view any droplet, and also gets its raw lifecycle `status`. A droplet you cannot see returns 404. ## OpenAPI ````yaml /api-reference/integrations-v0.yaml get /api/droplets/{uuid} openapi: 3.1.0 info: title: Fluid Integrations API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: droplets description: >- Create, list, and manage droplets — the apps a company publishes to the Fluid marketplace or builds for its own use. x-fluid-section: Droplets - name: droplet-installations description: >- Install droplets on a company, manage those installations, and let an installed droplet redeem its one-time exchange token for its credentials. x-fluid-section: Droplets paths: /api/droplets/{uuid}: get: tags: - droplets summary: shows a droplet description: >- Retrieve a droplet by its `uuid`. What you see depends on who you are: - Any company with the `droplets.view` permission can view a droplet it can see — a published droplet, one it owns, or one it was granted access to — along with its `owner_company`. - The owner company also gets its webhook URLs, `widget_data_url`, and `lifecycle_contract_version`. - A Fluid root administrator can view any droplet, and also gets its raw lifecycle `status`. A droplet you cannot see returns 404. operationId: integrations_v0_show_droplet parameters: - name: uuid in: path required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/ShowDropletResponse200ApplicationJsonSchema example: droplet: uuid: drp_4Tq8nXw2KfL9mRv3BpZ6cYh1JdS7aGe5u name: Middle-Out Order Analytics categories: - Analytics & Reporting active: true publicly_available: true embed_url: https://apps.piedpiper.com/fluid/embed requested_scopes: - orders - products - members created_at: '2026-09-08T16:20:44Z' settings: marketplace_page: title: Middle-Out Order Analytics logo_url: https://cdn.piedpiper.com/fluid/middle-out-logo.png summary: >- Order and rep performance dashboards, compressed to what matters. details_page: title: Middle-Out Order Analytics logo_url: https://cdn.piedpiper.com/fluid/middle-out-logo.png summary: >- See sales by rep, product, and country without exporting a single spreadsheet. features: - name: Rep leaderboards summary: Rank reps by sales and new enrollments. details: >- Daily leaderboards show which reps drive the most revenue, refreshed every hour from your Fluid orders. image_url: https://cdn.piedpiper.com/fluid/leaderboard.png video_url: null service_operational_countries: - USA - CAN app_extensions: [] updated_at: '2026-09-12T09:18:52Z' owner_company: id: 2210 name: Pied Piper meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-09-14T15:32:08Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '404': description: droplet not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: ShowDropletResponse200ApplicationJsonSchema: type: object required: - droplet - meta properties: droplet: anyOf: - $ref: '#/components/schemas/DropletShowPublicWithOwner' - $ref: '#/components/schemas/DropletShowOwnerWithDetails' - $ref: '#/components/schemas/DropletShowRootAdmin' meta: $ref: '#/components/schemas/Meta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' DropletShowPublicWithOwner: allOf: - $ref: '#/components/schemas/Droplet' - type: object required: - updated_at - owner_company properties: updated_at: type: string format: date-time owner_company: $ref: '#/components/schemas/DropletOwnerCompany' DropletShowOwnerWithDetails: allOf: - $ref: '#/components/schemas/DropletOwner' - type: object required: - updated_at - owner_company properties: updated_at: type: string format: date-time owner_company: $ref: '#/components/schemas/DropletOwnerCompany' DropletShowRootAdmin: title: Droplet as a root admin sees it description: >- Adds the raw lifecycle state, which the derived active and publicly_available booleans cannot express — they collapse internal with pending, and draft with archived. allOf: - $ref: '#/components/schemas/DropletShowOwnerWithDetails' - type: object required: - status properties: status: type: string enum: - draft - internal - pending - published - archived description: The droplet's raw lifecycle state. Root admins only. Meta: type: object required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' Droplet: title: Droplet type: object required: - uuid - name - categories - active - publicly_available - embed_url - requested_scopes - created_at - settings - app_extensions properties: uuid: type: string name: type: string categories: type: array items: type: string active: type: boolean default: false publicly_available: type: boolean default: false embed_url: type: - string - 'null' requested_scopes: type: array items: type: string created_at: type: string format: date-time settings: $ref: '#/components/schemas/DropletSettings' app_extensions: type: array items: $ref: '#/components/schemas/JsonValue' DropletOwnerCompany: title: Company type: object required: - id - name properties: id: type: integer name: type: string DropletOwner: allOf: - $ref: '#/components/schemas/Droplet' - type: object required: - install_webhook_url - uninstall_webhook_url - widget_data_url - lifecycle_contract_version properties: install_webhook_url: type: - string - 'null' uninstall_webhook_url: type: - string - 'null' widget_data_url: description: >- Endpoint Fluid calls when a widget this droplet published uses the droplet@1 capability. Null until the droplet declares one. type: - string - 'null' lifecycle_contract_version: type: string ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' DropletSettings: title: Droplet::Settings type: - object - 'null' properties: marketplace_page: $ref: '#/components/schemas/DropletMarketplacePage' details_page: $ref: '#/components/schemas/DropletDetailsPage' service_operational_countries: items: type: string pattern: ^[A-Z]{3}$ description: >- An array of ISO3 country codes for which the droplet is operational. A null value indicates that the service operates everywhere. An empty array indicates that the service operates nowhere. type: - array - 'null' DropletMarketplacePage: title: Droplet::MarketplacePage type: - object - 'null' required: - title properties: title: type: string logo_url: type: - string - 'null' summary: type: - string - 'null' DropletDetailsPage: title: Droplet::DetailsPage type: - object - 'null' required: - title properties: title: type: string logo_url: type: - string - 'null' summary: type: - string - 'null' features: type: - array - 'null' items: $ref: '#/components/schemas/DropletFeature' DropletFeature: title: Droplet::Feature type: object required: - name properties: name: type: string summary: type: - string - 'null' details: type: - string - 'null' image_url: type: - string - 'null' video_url: type: - string - 'null' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````