> ## 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. # Read your Today access > What you may do on your company's Today feed: whether you see it, may post and may moderate. Admins always see Today; a Member does not once the company's admins turn it off. Requires the messaging view permission. Today must be released to your company. ## OpenAPI ````yaml /api-reference/messaging-v1.yaml get /api/v1/messaging/today openapi: 3.1.0 info: title: Fluid Messaging v1 API description: | **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v1 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: messaging---conversations description: >- Create, list, update, and manage messaging conversations (direct, group, channel, SMS, email, and bot) as the signed-in company admin or rep. x-fluid-section: Messaging - name: messaging---incoming-webhooks description: >- Give another system a link that posts into a group conversation or channel, as with Slack's incoming webhooks. x-fluid-section: Messaging - name: messaging---messages description: >- Read, thread, and track unread state on messages in a conversation as the signed-in company admin or rep, including a message's thread replies and the threads with unread replies. x-fluid-section: Messaging - name: messaging---scheduled-messages description: >- Schedule, update, cancel, and immediately deliver messages in a conversation as the signed-in company admin or rep. x-fluid-section: Messaging - name: messaging---today description: >- Flow's Today feed, the company's X-style posts with likes, comments, shared storefront items and admin moderation, as the signed-in company admin or Member. Posting notifies nobody; only a post's author, and the people who commented on it, hear about likes and comments. x-fluid-section: Messaging paths: /api/v1/messaging/today: get: tags: - messaging---today summary: Read your Today access description: >- What you may do on your company's Today feed: whether you see it, may post and may moderate. Admins always see Today; a Member does not once the company's admins turn it off. Requires the messaging view permission. Today must be released to your company. operationId: messaging_v1_show_today responses: '200': description: Your Today access. content: application/json: schema: type: object properties: today: $ref: '#/components/schemas/MessagingTodayAccess' meta: $ref: '#/components/schemas/MessagingResponseMeta' required: - today example: today: available: true enabled: true posting: everyone can_post: true can_moderate: false viewer: id: 48219 first_name: Pam last_name: Beesly avatar_url: >- https://cdn.fluid.app/avatars/dunder-mifflin/pam-beesly.jpg avatar_background: EC4899 receivable_type: UserCompany bot: false meta: request_uuid: 3b8e2f61-9c4d-4a7e-8f12-6d5c4b3a2e10 timestamp: '2026-10-23T15:00:00Z' '401': description: unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '404': description: Today is not released to the company. content: application/json: schema: $ref: '#/components/schemas/MessagingApiError' security: - bearer_auth: [] components: schemas: MessagingTodayAccess: description: What the signed-in person may do on the company's Today feed. type: object properties: available: type: boolean description: >- Whether the person sees Today. False for a Member once the company's admins turned it off. enabled: type: boolean description: Whether the company's admins left Today on for Members. posting: type: string enum: - everyone - admins description: Who may post. can_post: type: boolean can_moderate: type: boolean description: >- Whether the person may pin posts, delete anyone's posts and comments and read reports (the company's admins). viewer: $ref: '#/components/schemas/MessagingTodayAuthor' description: >- The signed-in person as the feed shows an author, for the composer's avatar. required: - available - enabled - posting - can_post - can_moderate - viewer MessagingResponseMeta: description: Request metadata. type: object properties: request_uuid: type: - string - 'null' timestamp: type: string format: date-time UnauthorizedResponse: type: object properties: message: type: string required: - message MessagingApiError: description: A refused request. type: object properties: error: type: object properties: message: type: string details: type: object required: - message meta: $ref: '#/components/schemas/MessagingResponseMeta' required: - error MessagingTodayAuthor: description: >- Who wrote a Today post or comment, a person or a company bot. Never their contact details. type: object properties: id: type: integer description: The author's messaging recipient id. first_name: type: - string - 'null' last_name: type: - string - 'null' avatar_url: type: - string - 'null' avatar_background: type: - string - 'null' receivable_type: type: string bot: type: boolean description: Whether the author is one of the company's We-Bots. required: - id - first_name - last_name - avatar_url - bot securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.