> ## 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. # Update reporting database sync settings > Turns sync on or off, changes the hours between scheduled refreshes, or both. Only the fields you send change, so turning sync on never resets the interval. Turning sync off pauses refreshes and keeps the existing reporting database. Connector settings are not changed here. Requires a company admin user with the `reporting_databases.manage` permission. ## OpenAPI ````yaml /api-reference/reporting-databases-v2026-04.yaml patch /api/v202604/reporting_databases/settings openapi: 3.1.0 info: title: Fluid Reporting Databases API description: | Manage your company's Fluid reporting database: an isolated, read-only copy of your Fluid data that the reporting pipeline refreshes on a schedule, so you can query it from Mist or your own SQL tools without touching the live store. Each sync extracts your company's data, rebuilds the reporting tables, and swaps them into your reporting database. You control whether syncs run and how often, and you can ask for a sync right away. Turning sync off pauses refreshes and keeps the existing database intact. The settings endpoints back the **Reporting Databases** page in the Fluid admin. They require a Bearer token for a company admin user with the `reporting_databases.manage` permission. Admins hold that permission by default; no other default role does. The spec also records the completion callback the reporting pipeline posts after each refresh. That callback is service-to-service and is not part of the integrator API. version: v2026-04 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: reporting-database-settings description: | Read and change your company's reporting database settings: the sync switch, the hours between scheduled refreshes, and how fresh the data is. You can also request a sync without waiting for the next scheduled one. Every operation requires the `reporting_databases.manage` permission. x-fluid-section: Settings - name: reporting-sync-completions description: | The callback the reporting pipeline posts after it swaps a refresh into a company's reporting database. Service-to-service: authenticated by a shared secret header, never by a user token, and not intended for integrators. paths: /api/v202604/reporting_databases/settings: patch: tags: - reporting-database-settings summary: Update reporting database sync settings description: >- Turns sync on or off, changes the hours between scheduled refreshes, or both. Only the fields you send change, so turning sync on never resets the interval. Turning sync off pauses refreshes and keeps the existing reporting database. Connector settings are not changed here. Requires a company admin user with the `reporting_databases.manage` permission. operationId: reporting_databases_v202604_settings_update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSettingsRequest' examples: enable_every_twelve_hours: summary: Michael Scott turns on sync for Dunder Mifflin every 12 hours value: enabled: true sync_interval_hours: 12 responses: '200': description: The reporting database settings after the change content: application/json: schema: $ref: '#/components/schemas/FluidSettingsResponse' examples: enabled_every_twelve_hours: summary: Dunder Mifflin syncing every 12 hours value: fluid: enabled: true sync_interval_hours: 12 last_synced_at: '2026-09-07T07:06:00Z' last_sync_warnings_count: 0 last_sync_artifact_generation: '1788582025686682' status: 200 meta: request_id: 9d0e4b7a-3c61-4f0e-8a52-6b1f2e7c4d90 timestamp: '2026-09-07T20:05:00Z' '401': description: Not authenticated, or a company API token with no user behind it content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The user is not a company admin, or lacks the `reporting_databases.manage` permission content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '422': description: >- `enabled` was not a boolean, `sync_interval_hours` was not a positive integer, or the settings could not be saved content: application/json: schema: $ref: '#/components/schemas/LegacyErrorResponse' security: - bearer_auth: [] components: schemas: UpdateSettingsRequest: type: object description: >- Either or both fields. Only the keys sent are applied, so toggling `enabled` never resets the interval. additionalProperties: false properties: enabled: type: boolean description: >- Turn the sync on or off. Must be a real boolean; "yes" and 1 are rejected. example: true sync_interval_hours: type: integer minimum: 1 description: >- Hours between scheduled refreshes. Must be a positive integer; there is no upper bound. example: 12 FluidSettingsResponse: type: object description: The Fluid half of the page, after a change. additionalProperties: false required: - fluid - status - meta properties: fluid: $ref: '#/components/schemas/FluidSettings' status: type: integer description: The HTTP status code echoed in the envelope. example: 200 meta: $ref: '#/components/schemas/ResponseMeta' UnauthorizedResponse: type: object description: No usable credentials, or a company API token with no user behind it. additionalProperties: false required: - message properties: message: type: string description: Why authentication failed. example: Invalid credentials ForbiddenResponse: description: >- The caller is authenticated but may not use this page: either the user is not a company admin, or the admin's role lacks the `reporting_databases.manage` permission. oneOf: - type: object description: >- An admin whose role lacks the `reporting_databases.manage` permission. additionalProperties: false required: - error properties: error: type: string description: Why authorization failed. example: Not authorized - type: object description: A user who is not a company admin. additionalProperties: false required: - message properties: message: type: string description: Why authorization failed. example: Not authorized LegacyErrorResponse: type: object description: A refused request, with the reason and any field errors. additionalProperties: false required: - error - status - meta properties: error: type: object description: Why the request was refused. additionalProperties: false required: - message - details properties: message: type: string description: What was wrong with the request. example: Enable reporting database sync before requesting a manual sync details: type: object description: >- Validation errors keyed by field, when a save was refused; empty otherwise. additionalProperties: true status: type: integer description: The HTTP status code echoed in the envelope. example: 422 meta: $ref: '#/components/schemas/ResponseMeta' FluidSettings: type: object description: >- The company's Fluid reporting database contract and the state the pipeline last reported for it. additionalProperties: false required: - enabled - sync_interval_hours - last_synced_at - last_sync_warnings_count - last_sync_artifact_generation properties: enabled: type: boolean description: >- Whether scheduled and requested syncs run for the company. Defaults to false. Turning it off pauses syncs and keeps the existing database. example: true sync_interval_hours: type: integer minimum: 1 description: >- Hours between scheduled refreshes. Any positive integer, with no upper bound; defaults to 6. example: 6 last_synced_at: type: - string - 'null' format: date-time description: >- When the pipeline last swapped a refresh into the company's reporting database. Null until the first sync completes. example: '2026-09-07T07:06:00Z' last_sync_warnings_count: type: - integer - 'null' minimum: 0 description: >- How many warning-level data-quality checks fired during the last completed refresh. Null until a refresh that reports it has completed. example: 2 last_sync_artifact_generation: type: - string - 'null' pattern: ^[0-9]+$ description: >- The build identifier of the pipeline release that produced the tables in the last completed refresh. It tells you which version of the pipeline built the rows, which `last_synced_at` cannot. Null until a refresh that reports it has completed. example: '1788582025686682' ResponseMeta: type: object description: Request metadata included in every settings response. additionalProperties: false required: - request_id - timestamp properties: request_id: type: - string - 'null' description: The request id from the request's log line, when one was assigned. example: 5c3a1c1e-2f2d-4a2f-9f6b-1e5d1c0b9a77 timestamp: type: string format: date-time description: When the response was rendered. example: '2026-09-07T20:00:00Z' securitySchemes: bearer_auth: type: http scheme: bearer description: >- A Bearer token for a company admin user. A company API token with no user behind it is refused with 401. ````