> ## 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. # Show a site's database status > The state of the site's database and the limits of its routes. It reads Fluid's own record and sends nothing to the backend, so it answers while the backend is still being created and for a draft site, and a site with no database is 404. It never returns a storage figure, the backend's address, its secret or a vendor id. On the cookie mount, the request needs the session cookie, the CSRF token on a write, the `X-Fluid-Member-Site` header naming this site, and a published declaration of the site that lists `database: read`; a site that declared nothing is refused, because an owner holds no `database` scope unless the site declares it. A bearer reaches it as the owner whatever the site declares. Every response is `private, no-store`. ## OpenAPI ````yaml /api-reference/member-sites-v2026-10.yaml get /api/member/v2026-10/sites/{site_id}/database openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Sites description: > The authenticated member's own sites: list, create, read, change, delete, publish and copy, list a site's versions and restore one, with the files and pages that make up each site, and the branch a member makes to try a change to a published site. The credential alone determines the member and company; a site and a page are identified by their public ids, never by a numeric id. A member can read and change only the sites they own. Any other id, and any id of a site in another company, returns 404. These operations take a bearer only, the site menu, the site removals and the share-target search included, except the status, tables and rows operations of a site's database (see the `site-database` tag), which a site's own script reaches on the cookie mount when the site has declared them. On the same-origin cookie mount, a request with a valid member session is refused with `403`, with or without an `X-Fluid-Member-Site` header, because a script on the company's storefront shares that origin and would otherwise act as the visiting member, so no cookie path to them can be kept from it; a request with a missing or unusable session is refused with `401` first, as on every cookie-mount route. A page that draws the account menu holds the member's bearer and sends it itself. The draft preview operations show the member's own site as its builder sees it before it is published. They answer with a page's HTML or a file's text rather than the JSON envelope, and every response of theirs, a refusal included, carries the frame's sandbox policy and is `private, no-store` and `noindex`. See the `site-preview` tag. Every operation returns 404 while member sites are not enabled for the member's company (the `MEMBER_SITES` company feature). A credential that is refused is still refused with 401 or 403 first, so a refused credential never learns whether the feature is enabled. **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 refuses a credential for it with `403` and the standard error envelope, before the operation runs. 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: sites x-fluid-section: Members description: >- The signed-in member's own sites, with publishing, copying and optimistic locking. - name: site-branches x-fluid-section: Members description: >- The branch of one of the member's published sites, a private copy of the site that only its owner and company admins can open, with a preview of its own, where a change can be tried without touching the site. - name: site-files x-fluid-section: Members description: >- The files of one of the member's sites (layouts, sections, snippets, assets, page content, settings and menus), addressed by theme-style path. - name: site-shares x-fluid-section: Members description: >- Who one of the member's sites is shared with, a named member, the member's downline or a segment of the company's members, each with a view or copy permission. - name: site-pages x-fluid-section: Members description: >- The pages of one of the member's sites, each with the template that holds its content. - name: site-preview x-fluid-section: Members description: >- The draft of one of the member's own sites, rendered as it will be served once published, for the builder's own tools. - name: site-menu x-fluid-section: Members description: >- The member's account menu, grouped into the company's sites, the sites they built, the sites shared with them and the sites they removed. - name: site-removals x-fluid-section: Members description: >- Taking a site out of the member's own account menu, and putting it back. A removal changes nothing for the site's owner or for anyone else. - name: site-pins x-fluid-section: Members description: >- Pinning sites to the member's own account menu, in an order the member chooses. A pin changes nothing for the site's owner or for anyone else. - name: site-home x-fluid-section: Members description: >- The site the member chooses as their home, the one their account opens on. A home changes nothing for the site's owner or for anyone else. - name: site-share-targets x-fluid-section: Members description: >- Whom the member may share a site with, inside the reach their company's messaging policy gives them. - name: site-database x-fluid-section: Members description: >- The database of one of the member's sites, read and written through the site's own backend with six fixed operations. The status, tables and rows operations are served to the owner's bearer and, on the cookie mount, to a site that sends its own `X-Fluid-Member-Site` label and has published a declaration naming `database: read` or `database: write`; the SQL statement operation is bearer only. paths: /api/member/v2026-10/sites/{site_id}/database: parameters: - $ref: '#/components/parameters/SiteIdPath' get: tags: - site-database summary: Show a site's database status description: > The state of the site's database and the limits of its routes. It reads Fluid's own record and sends nothing to the backend, so it answers while the backend is still being created and for a draft site, and a site with no database is 404. It never returns a storage figure, the backend's address, its secret or a vendor id. On the cookie mount, the request needs the session cookie, the CSRF token on a write, the `X-Fluid-Member-Site` header naming this site, and a published declaration of the site that lists `database: read`; a site that declared nothing is refused, because an owner holds no `database` scope unless the site declares it. A bearer reaches it as the owner whatever the site declares. Every response is `private, no-store`. operationId: member_site_database_status responses: '200': description: The database's state and limits. headers: Cache-Control: description: Always `private, no-store`. No ETag is sent. schema: type: string example: private, no-store content: application/json: schema: $ref: '#/components/schemas/SiteDatabaseStatusEnvelope' example: status: 200 data: state: live available: true limits: request_body_bytes: 65536 response_body_bytes: 262144 calls_per_minute: 60 rows_per_page_default: 25 rows_per_page_max: 100 rows_per_insert_max: 100 rows_returned_by_sql_max: 100 statement_timeout_seconds: 3 meta: request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e timestamp: '2026-09-30T15:08:21Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/DatabaseRefused' '404': $ref: '#/components/responses/DatabaseNotFound' '422': $ref: '#/components/responses/DatabaseInvalid' components: parameters: SiteIdPath: name: site_id in: path required: true description: Public id of one of the member's sites. schema: type: string format: uuid schemas: SiteDatabaseStatusEnvelope: type: object description: The state and limits of a site's database. properties: status: type: integer description: HTTP status code (mirrors the response status line). data: $ref: '#/components/schemas/SiteDatabaseStatus' meta: $ref: '#/components/schemas/ResponseMeta' required: - status - data - meta SiteDatabaseStatus: type: object description: >- The state and limits of a site's database. It holds no storage figure, no address, no secret and no vendor id. additionalProperties: false properties: state: type: string enum: - provisioning - live - failed - pending_destroy - archived - discarded description: >- The state of the database's hosting. Only `live` answers calls. While it is `provisioning`, check this state again until it is `live`. In `failed`, `pending_destroy`, `archived` or `discarded`, the owner asks for the database again with `POST` on this path, which replaces it. example: live available: type: boolean description: >- Whether the database answers calls now, which is true only for a live hosting that has an address. It is not true for a draft site, whose database routes answer 404 until the site is published. example: true limits: $ref: '#/components/schemas/SiteDatabaseLimits' required: - state - available - limits 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 ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object description: The error message and field-keyed details. properties: message: type: string description: Human-readable error message. details: type: object description: >- Machine-readable details, keyed by field where a field is at fault. additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta SiteDatabaseLimits: type: object description: The bounds of a site's database routes. additionalProperties: false properties: request_body_bytes: type: integer description: >- The largest request body accepted, 64 KiB. A larger one is refused with 413. example: 65536 response_body_bytes: type: integer description: >- The largest answer read from the site's backend, 256 KiB. A longer one is abandoned and answered with 502. example: 262144 calls_per_minute: type: integer description: >- Calls allowed per minute for one company, member and site. More are refused with 429. example: 60 rows_per_page_default: type: integer description: Rows in a page of a table when `page[limit]` is not sent. example: 25 rows_per_page_max: type: integer description: The most rows `page[limit]` may ask for. example: 100 rows_per_insert_max: type: integer description: The most rows one insert may carry. example: 100 rows_returned_by_sql_max: type: integer description: The most rows a SQL statement returns, with `truncated` true beyond. example: 100 statement_timeout_seconds: type: integer description: How long any operation may run in the database before it is stopped. example: 3 required: - request_body_bytes - response_body_bytes - calls_per_minute - rows_per_page_default - rows_per_page_max - rows_per_insert_max - rows_returned_by_sql_max - statement_timeout_seconds responses: Unauthorized: description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' DatabaseRefused: description: >- The credential is a member session JWT, the kind order and subscription email links carry, which no database operation accepts; the credential is a portal JWT minted read-only and the request writes; the credential belongs to a sandbox test company that cannot be reached now; or the request is on the cookie mount and is refused. A cookie-mount request is refused when it carries no `X-Fluid-Member-Site` label, a malformed one or one that names another site than the path's; when the labelled site is not published, is not the session member's own or has not declared the scope the request needs, which `details.scope` names (`database: read` for a read and `database: write` for a write); and always for the SQL statement operation. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' DatabaseNotFound: description: >- No site of the member's has this id, the site has no database, a draft or taken-down site is named by an operation that reaches the backend, or member sites are not enabled for the member's company. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' DatabaseInvalid: description: >- A parameter is refused before anything is sent, with `details` keyed by field (a key the operation does not take, including `operation`, `member`, `company`, `site` and `url`; a table or column that is not an identifier; a filter operator outside the list; `page[limit]` outside 1 to 100; more than 100 rows; an empty statement or `values`); or the backend refused the operation with its own reason in `message` (`constraint_violation`, `invalid_params`, `invalid_statement`, `statement_timeout`, `row_too_large`), with the backend's answer in `details.backend_response`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' 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, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.