> ## 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. > 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 — 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. # Show notification preferences > The member's channel switches, per-family push and email choices, and do-not-disturb settings. Shared by every membership of the member's user. ## OpenAPI ````yaml /api-reference/member-settings-v2026-10.yaml get /api/member/v2026-10/notifications/preferences openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Settings description: > Includes notification preferences shared across the member user's memberships. The agreements that apply to the signed-in member and their acceptance. Every operation acts as the member the bearer credential speaks for; the member and their company come from the credential alone. Acceptance here is the same record the company's login agreement check reads; it is not a checkout gate, which stays a storefront concern. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: agreements description: >- The company agreements that apply to the member, their text, and the member's versioned acceptance. x-fluid-section: Settings - name: notification-preferences description: >- Which notifications the member receives on which channel, and when not to disturb them. x-fluid-section: Settings paths: /api/member/v2026-10/notifications/preferences: get: tags: - notification-preferences summary: Show notification preferences description: >- The member's channel switches, per-family push and email choices, and do-not-disturb settings. Shared by every membership of the member's user. operationId: member_notifications_preferences_show parameters: - name: If-None-Match in: header required: false description: >- A previously returned ETag. Authentication runs before a 304 is considered. schema: type: string responses: '200': description: The preferences. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/NotificationPreferencesEnvelope' example: status: 200 data: channels: push: true email: true sms: false families: activity: push: true email: null orders: push: true email: true messaging: push: true email: false general: push: true email: true dnd: mode: 'off' schedule: name: weekdays start_time: '21:00' end_time: '07:30' days: null meta: request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e timestamp: '2026-10-01T15:08:21Z' '304': description: The representation has not changed since the supplied ETag. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '401': description: >- Missing credential, or a credential that is not a usable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: headers: ETag: description: >- Fingerprint of this member's representation. Send it back in If-None-Match to skip the body while it is unchanged. schema: type: string CacheControl: description: Standard HTTP Cache-Control directive. Always private for this surface. schema: type: string example: max-age=60, private schemas: NotificationPreferencesEnvelope: type: object description: The member's notification preferences. required: - status - data - meta properties: status: type: integer data: $ref: '#/components/schemas/NotificationPreferences' meta: $ref: '#/components/schemas/ResponseMeta' ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta NotificationPreferences: type: object description: The member's notification preferences. additionalProperties: false required: - channels - families - dnd properties: channels: type: object description: >- Master switches. A channel switched off delivers nothing, whatever the families say. additionalProperties: false required: - push - email - sms properties: push: type: boolean email: type: boolean sms: type: boolean description: SMS is a channel switch only; it has no per-family choice. families: type: object description: Push and email choices for each family of notifications. additionalProperties: false required: - activity - orders - messaging - general properties: activity: $ref: '#/components/schemas/FamilyChoice' orders: $ref: '#/components/schemas/FamilyChoice' messaging: $ref: '#/components/schemas/FamilyChoice' general: $ref: '#/components/schemas/FamilyChoice' dnd: type: object description: Do not disturb. additionalProperties: false required: - mode - schedule properties: mode: type: string enum: - 'off' - all - push - email description: Silence everything, only push, only email, or nothing. schedule: type: object description: >- Recurring quiet hours, in the user's time zone. They apply only in companies that enable scheduled do-not-disturb. additionalProperties: false required: - name - start_time - end_time - days properties: name: type: string enum: - everyday - weekdays - weekends - custom description: Which days the quiet hours apply. start_time: type: string pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ description: >- When quiet hours start. With an end earlier than the start, legacy delivery suppresses the evening portion only; the following morning is not suppressed. end_time: type: string pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ description: When quiet hours end. days: description: >- Per-day quiet hours for a `custom` schedule; null for the named schedules. oneOf: - type: 'null' - $ref: '#/components/schemas/CustomScheduleDays' ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. required: - request_uuid - timestamp additionalProperties: true FamilyChoice: type: object description: Push and email choices for one family of notifications. additionalProperties: false required: - push - email properties: push: type: - boolean - 'null' description: >- True or false when every notification in the family agrees; null when they differ (set individually in another client). email: type: - boolean - 'null' description: >- True or false when every notification in the family agrees; null when they differ (set individually in another client). CustomScheduleDays: type: object description: >- Per-day quiet hours for a `custom` schedule. Only the days present apply. additionalProperties: false properties: monday: $ref: '#/components/schemas/DayRange' tuesday: $ref: '#/components/schemas/DayRange' wednesday: $ref: '#/components/schemas/DayRange' thursday: $ref: '#/components/schemas/DayRange' friday: $ref: '#/components/schemas/DayRange' saturday: $ref: '#/components/schemas/DayRange' sunday: $ref: '#/components/schemas/DayRange' DayRange: type: object description: >- Quiet hours on the selected day. When the end precedes the start, legacy delivery suppresses the evening portion only; the following morning is not suppressed. This preserves the existing custom-schedule behavior. additionalProperties: false required: - start_time - end_time properties: start_time: type: string pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ description: 24-hour local time, `HH:MM`. end_time: type: string pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ description: 24-hour local time, `HH:MM`. securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.