> ## 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. # Get the Member messaging policy > The company's policy, or the defaults when it never saved one. Needs `members.view`. ## OpenAPI ````yaml /api-reference/company-messaging-v2026-10.yaml get /api/company/v2026-10/messaging/member-policy openapi: 3.1.0 info: title: >- Fluid Company API v2026-10 — Flow member messaging policy, channel moderation and Today version: 2026-10 description: >- Whom your Members may see, search and message in Flow (Fluid Messaging), and which contact fields they see on each other. Some companies keep Members from finding and messaging each other, to prevent cross-recruiting between teams or for privacy. The policy only limits a Member reaching another Member: admins, staff and bots are always reachable, and a Member can always reach them. Name and avatar are always shown. Fluid enforces the policy in search, member lists, new direct and group conversations, new messages and contact fields; an existing conversation with a Member who is now out of reach keeps its history, leaves the Member's list and takes no new messages. Admins of your company, and bots running with their owner's rights, also moderate the company's channels: they read the messages of the channels they are in and remove or restore anyone's message in any channel. Direct and group conversations are never moderated. They moderate the company's Today feed too: read its posts and comments, archived ones included, archive or restore them with a reason, and read the open reports. Archived items leave the feed for everyone else and keep their likes and comments for a restore; every archive and restore is audited, naming the admin, or the bot and its owner. Sign in as an admin of your company (`bearer_auth`). contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: [] tags: - name: messaging-member-policy description: The company's Member messaging policy for Flow. x-fluid-section: Settings - name: channel-messages description: Reading, removing and restoring messages in the company's Flow channels. x-fluid-section: Messaging - name: messaging-today description: Reading and moderating the company's Today feed in Flow. x-fluid-section: Messaging paths: /api/company/v2026-10/messaging/member-policy: get: tags: - messaging-member-policy summary: Get the Member messaging policy description: >- The company's policy, or the defaults when it never saved one. Needs `members.view`. operationId: companyMessagingMemberPolicyShow responses: '200': description: The policy. content: application/json: schema: $ref: '#/components/schemas/MemberPolicyResponse' example: member_policy: directory_scope: team_graph include_upline: true show_email: false show_phone: false show_bio: true today_enabled: true today_posting: everyone updated_at: '2026-10-23T09:30:00Z' status: 200 meta: request_uuid: 0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a90 timestamp: '2026-10-23T09:31:00Z' '401': description: Not signed in. content: application/json: schema: $ref: '#/components/schemas/LegacyError' '403': description: Not an admin of the company, or missing `members.view`. content: application/json: schema: $ref: '#/components/schemas/LegacyError' security: - bearer_auth: [] components: schemas: MemberPolicyResponse: type: object required: - member_policy - status - meta properties: member_policy: $ref: '#/components/schemas/MemberPolicy' status: type: integer meta: $ref: '#/components/schemas/Meta' LegacyError: description: The error body an authorization refusal answers with. type: object additionalProperties: true MemberPolicy: type: object description: The company's Member messaging policy. required: - directory_scope - include_upline - show_email - show_phone - show_bio - today_enabled - today_posting - updated_at additionalProperties: false properties: directory_scope: type: string enum: - all_members - team_graph - no_direct_messages description: >- Whom a Member may see, search and message among your Members. `all_members`: everyone (the default). `team_graph`: only Members in their Team Graph, their downline on any tree. `no_direct_messages`: no other Member. include_upline: type: boolean description: >- Under `team_graph`, whether a Member also reaches the Members above them on each tree, such as their sponsor. Defaults to true. show_email: type: boolean description: Whether a Member sees another Member's email. Defaults to true. show_phone: type: boolean description: >- Whether a Member sees another Member's phone number. Defaults to true. show_bio: type: boolean description: Whether a Member sees another Member's bio. Defaults to false. today_enabled: type: boolean description: >- Whether Members see Flow's Today feed. Admins always see it. Defaults to true. today_posting: type: string enum: - everyone - admins description: 'Who may post to Today: `everyone` (the default) or only `admins`.' updated_at: type: - string - 'null' format: date-time description: >- When the policy was last changed; null while the company uses the defaults. Meta: type: object description: Response metadata. 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. securitySchemes: bearer_auth: type: http scheme: bearer description: The session token of an admin of your company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.