> ## 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. > 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. # Report desktop presence > A desktop app (Mist) registers its install and, about once a minute while the person is using it, reports them active. Send the install's id in the X-Fluid-Device-Id header on every request too: once the device is signed out, that session is answered 401 `device_signed_out`. ## OpenAPI ````yaml /api-reference/company-messages-v2026-10.yaml put /api/company/v2026-10/devices/desktop openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Messages version: 2026-10 description: >- Send email, SMS, WhatsApp, push notifications and Flow messages to your members, customers and contacts, and see whether they were delivered. Every message goes out from your company's own identities: email from your company's sending address (Amazon SES), SMS from your registered number (Twilio). Fluid never falls back to a shared sender. If a channel isn't set up yet, the request is refused with a clear `code` and a `setup` block saying what's left and where to finish it. Name the recipient with exactly one of `to` (an address), `contact_id`, `customer_id` or `member_id`. Customers and members are the same people. Push, preferred and Flow take `member_id` only. To message someone inside Flow, use `POST /api/company/v2026-10/messages/flow`, or Flow's own messaging API (`POST /api/v1/messaging/conversations` and `POST /api/v1/messaging/conversations/{id}/messages`). Every send, accepted or refused, is kept with its delivery events, so `GET /api/company/v2026-10/messages/{id}` shows what happened. Delivery outcomes also teach Fluid about the address: a delivery marks it verified, and a hard bounce, complaint, invalid number or unsubscribe marks it as no longer usable. Sign in as an admin of your company, or use a company API token, a droplet token holding the opt-in `messaging` scope, or a bot token (`bearer_auth`). Each channel needs its own permission: `outbound_messages.email`, `.sms`, `.whatsapp`, `.push` or `.flow`; reading a message needs `outbound_messages.view`. A bot's send is a `message_customer` action (`GET /api/company/v2026-10/bot-action-classes`), so its owner's mode for messaging people decides whether it waits for approval, and the send rules apply as to any other sender. 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: outbound-messages description: Send messages to members, customers and contacts, and track delivery. x-fluid-section: Messaging - name: contact-methods description: Every way to reach a member or contact, and a member's devices. x-fluid-section: Messaging - name: flow-senders description: >- Who apps post Flow messages as: each app's own sender, and the people who let an app send as them. x-fluid-section: Messaging - name: devices description: >- A person's phones and desktop apps, desktop presence, and signing a device out. x-fluid-section: Messaging paths: /api/company/v2026-10/devices/desktop: put: tags: - devices summary: Report desktop presence description: >- A desktop app (Mist) registers its install and, about once a minute while the person is using it, reports them active. Send the install's id in the X-Fluid-Device-Id header on every request too: once the device is signed out, that session is answered 401 `device_signed_out`. operationId: companyDesktopDevicePresence requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DesktopPresenceBody' example: device: device_uid: 7c1e9a4f-2b8d-4e6a-9f3c-5d7b1e2a8c40 bundle_id: app.fluid.mist app_version: 1.1.0 device_name: MacBook Pro os_name: macOS 15.1 active: true responses: '200': description: The device. content: application/json: schema: $ref: '#/components/schemas/DeviceResponse' example: device: id: 0199e5b2-7c8d-7e9f-9a0b-1c2d3e4f5a6b device_type: desktop bundle_id: app.fluid.mist last_seen_at: '2026-10-23T14:04:51Z' registered_at: '2026-10-01T15:30:00Z' push_status: desktop kind: desktop app_version: 1.1.0 device_name: MacBook Pro os_name: macOS 15.1 last_active_at: '2026-10-23T14:04:51Z' signed_out_at: null status: 200 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-10-23T14:05:12Z' '401': description: Not signed in, or this device was signed out (`device_signed_out`). content: application/json: schema: anyOf: - $ref: '#/components/schemas/DeviceSignedOut' - $ref: '#/components/schemas/LegacyError' '403': description: Not a signed-in person. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: DesktopPresenceBody: type: object additionalProperties: false required: - device properties: device: type: object additionalProperties: false required: - device_uid properties: device_uid: type: string minLength: 8 maxLength: 100 description: >- The install's stable id; one row per install, per person and company. bundle_id: type: string maxLength: 200 description: e.g. app.fluid.mist app_version: type: string maxLength: 50 device_name: type: string maxLength: 200 os_name: type: string maxLength: 100 active: type: boolean description: >- Whether the person used the app in the last minute; marks them active now. DeviceResponse: type: object required: - device - status - meta properties: device: $ref: '#/components/schemas/Device' status: type: integer meta: $ref: '#/components/schemas/Meta' DeviceSignedOut: type: object required: - error - message properties: error: type: string enum: - device_signed_out message: type: string LegacyError: description: The error body an authorization refusal answers with. type: object additionalProperties: true ErrorResponse: type: object required: - error - status - meta properties: error: type: object required: - message properties: message: type: string details: type: object additionalProperties: true status: type: integer meta: $ref: '#/components/schemas/Meta' Device: type: object additionalProperties: false description: >- A phone, tablet or desktop app (Mist) the person signed in on. Shown only to the person and to admins, never to other members or guests. required: - id - device_type - bundle_id - last_seen_at - registered_at - push_status - kind - app_version - device_name - os_name - last_active_at - signed_out_at properties: id: type: string format: uuid device_type: type: - string - 'null' description: ios, android or desktop. bundle_id: type: - string - 'null' description: Which app it's signed in to. last_seen_at: type: - string - 'null' format: date-time registered_at: type: - string - 'null' format: date-time push_status: type: string enum: - active - expired - no_token - desktop description: >- active: push can reach it. expired: not seen for a while, so its token may no longer work. desktop: a desktop app, which gets no phone push. kind: type: string enum: - phone - desktop description: A desktop app has no push token. app_version: type: - string - 'null' description: The app's version, e.g. 1.1.0. device_name: type: - string - 'null' description: The machine's name, e.g. MacBook Pro. os_name: type: - string - 'null' description: The operating system, e.g. macOS 15.1. last_active_at: type: - string - 'null' format: date-time description: >- When the person last used the desktop app. While it is within two minutes, Flow message pushes to their phones wait two minutes and are dropped if they read the message on the desktop. signed_out_at: type: - string - 'null' format: date-time description: When the desktop app was signed out. Meta: type: object description: Response metadata. required: - request_uuid - timestamp properties: request_uuid: type: - string - 'null' timestamp: type: string format: date-time securitySchemes: bearer_auth: type: http scheme: bearer description: An admin session, company API token, droplet token or bot token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.