> ## 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. # List placement mirror runs > The company's most recent background placement mirror runs, newest first. Requires a persisted company admin identity and members.manage (or users.update), as starting a run does; droplet tokens are not supported. Read from the primary, so progress is current. ## OpenAPI ````yaml /api-reference/genealogy-v2026-10.yaml get /api/company/v2026-10/genealogy/mirror-runs openapi: 3.1.0 info: title: Genealogy trees and recorded history version: 2026-10 description: >- Company-owned tree definitions and recorded relationships. A node is one member's seat in a tree; a placement records its parent during a half-open time interval. The node shows the current relationship, while the placement journal supports as-of reads. Member history is always restricted by current team scope. Moves take effect at server time: an immediate/no-op outcome returns 200, while an approval request or deferred job returns 202 with a receipt. Large previews return validation_incomplete until the full check runs in a worker; they do not authorize a write. HTTP move submission and approval require explicit company admission after migration checks. The examples use fixture identities, never usable authentication tokens. Outgoing webhook snapshots describe the recorded transition even if a receipt changes later. servers: - url: https://api.fluid.app description: Fluid API security: - bearerAuth: [] tags: - name: Genealogy trees description: Configure the company tree registry and explicit ownership declarations. - name: Genealogy history description: Read recorded relationships under current company or member authorization. - name: Genealogy moves description: Preview and request current-time genealogy moves. - name: Genealogy reads description: Read current relationships from existing company-owned nodes. x-fluid-section: Members - name: Genealogy placement description: Place members in binary and matrix trees and manage their holding tank. x-fluid-section: Members paths: /api/company/v2026-10/genealogy/mirror-runs: get: tags: - Genealogy placement summary: List placement mirror runs description: >- The company's most recent background placement mirror runs, newest first. Requires a persisted company admin identity and members.manage (or users.update), as starting a run does; droplet tokens are not supported. Read from the primary, so progress is current. operationId: listCompanyGenealogyMirrorRuns parameters: - in: query name: status required: false description: Only runs in this status. schema: type: string enum: - queued - running - succeeded - failed - halted - in: query name: limit required: false description: How many runs to return, 1 to 100 (default 25). schema: type: integer minimum: 1 maximum: 100 responses: '200': description: The most recent runs. content: application/json: schema: type: object required: - mirror_runs - status - meta properties: status: type: integer meta: type: object mirror_runs: type: array items: $ref: '#/components/schemas/MirrorRun' example: status: 200 mirror_runs: - id: 01a08944-f646-7385-b8c7-a71782556f1a tree_id: 7096ad49-7117-53f6-8f7f-4805473d14c5 status: succeeded counts: seated: 50 followed: 0 unchanged: 2 pinned: 0 parent_unseated: 0 failed: 0 failures: [] failure_type: null failure_description: null windows: 2 attempts: 1 requested_by_id: c0dd6812-0ba6-56d2-879c-a36112f813c2 created_at: '2026-10-07T00:00:00.000000Z' started_at: '2026-10-07T00:00:01.000000Z' finished_at: '2026-10-07T00:00:03.000000Z' meta: request_uuid: null timestamp: '2026-10-07T00:00:05Z' '401': description: Credentials are missing or invalid. content: application/json: schema: $ref: '#/components/schemas/AuthError' '403': description: A company admin identity or members.manage is required. content: application/json: schema: $ref: '#/components/schemas/AuthError' '422': description: Invalid parameters. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: Shell label: List placement mirror runs source: >- curl -X GET 'https://api.fluid.app/api/company/v2026-10/genealogy/mirror-runs?limit=5' \ -H 'Authorization: Bearer ' components: schemas: MirrorRun: type: object additionalProperties: false description: >- A background backfill of the placement tree from the enrollment tree. A run that resumed after its worker stopped starts its tally again; members the earlier attempt mirrored count as unchanged. required: - id - tree_id - status - counts - failures - failure_type - failure_description - windows - attempts - requested_by_id - created_at - started_at - finished_at properties: id: type: string format: uuid tree_id: type: string format: uuid description: The placement (sponsor-role) tree. status: type: string enum: - queued - running - succeeded - failed - halted description: >- failed when a refusal or error stopped the run before it mirrored anyone; halted when a refusal or the window bound stopped it after batches were written, which stand (rerun to finish). counts: type: object additionalProperties: false description: Members per outcome so far. required: - seated - followed - unchanged - pinned - parent_unseated - failed properties: seated: type: integer followed: type: integer unchanged: type: integer pinned: type: integer parent_unseated: type: integer failed: type: integer failures: type: array description: The first 50 members the placement engine refused. items: type: object required: - member_id - type - description properties: member_id: type: string format: uuid type: type: string description: type: string failure_type: type: - string - 'null' description: >- Why a failed or halted run stopped (for example placement_too_shallow, mirror_members_refused, mirror_window_limit, mirror_run_error). failure_description: type: - string - 'null' windows: type: integer description: Lock windows opened so far; each mirrors up to 100 members. attempts: type: integer description: Times a worker claimed the run; above 1 after a resume. requested_by_id: type: string format: uuid description: The company admin who started the run. created_at: type: string format: date-time started_at: type: - string - 'null' format: date-time finished_at: type: - string - 'null' format: date-time AuthError: type: object description: Existing company authentication or permission denial envelope. properties: message: type: string error: {} additionalProperties: true Error: type: object properties: status: type: integer error: type: object properties: message: type: string details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/Meta' required: - status - error - meta Meta: type: object properties: request_uuid: type: - string - 'null' description: Request correlation identifier. timestamp: type: string description: Response timestamp. format: date-time required: - request_uuid - timestamp securitySchemes: bearerAuth: type: http scheme: bearer description: >- Company admin or company service token, subject to developer permissions. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.