> ## 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. # Genealogy CLI > Read, rank, and change your company's genealogy trees from the terminal with fluid genealogy: uplines, downlines, leg headcounts, placements, moves, move requests, and tree definitions. A genealogy tree records who sits under whom in your company: each member holds a **seat** (a node) in a tree, under a parent seat. The `fluid genealogy` commands read and change those trees through the company genealogy API, `/api/company/v2026-10/genealogy/...`. They are for company admins and integrators who manage a company's trees. To build a member's own view of their team, use the [member API](/api/member-apis) instead. ## Install and sign in Install the Fluid CLI and its genealogy plugin from npm, then sign in: ```bash theme={null} npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-genealogy fluid login ``` What you can run depends on who is signed in: | Commands | Who can run them | | - | - | | Reads, legs, and move receipts | A company admin with `members.view` (or the older `users.view`), or a company API token with that permission | | `trees` (list the full tree definitions) | Also needs `developer.view`, because the definitions carry company configuration | | `place` and `move` | A company admin signed in with `fluid login`, with `members.manage` | | `move-requests approve` and `reject` | A company admin signed in with `fluid login`, with `team_moves.approve` | | `trees create`, `update`, and `delete` | A company admin with `developer.update`. A company API token works only if its role grants it. | Placements, moves, and move decisions need an admin's own sign-in. A company API token is refused for them. Every command except `tree` prints JSON. A failure prints a JSON `error` on stderr, with the API's `type` and `status` when there are any, and exits with a non-zero code. ### Choose a seat Most commands take the seat to start from in one of two ways: * A node ID, such as `3f6a1c2e-8b4d-4e7a-9c1f-2d5b8e0a7c34`. * `--member ` with `--tree `, which uses that member's seat in the tree. `--tree` takes a tree key or UUID and defaults to `placement`. A member with no seat in the tree, or with more than one, is an error. When a member holds several seats, the error lists them so you can pass the node ID. `fluid genealogy show` reads one seat with its `children_count` and `downline_count`, and `fluid genealogy trees` lists your company's tree definitions and their keys. ```bash theme={null} fluid genealogy show --member 8c2e4f71-5a9d-4b3e-a6c0-71d9e2f4b58a --tree placement ``` ## Read trees | Command | What it reads | | - | - | | `parent`, `root` | The seat's parent (`null` for a root), or the root of its tree | | `sponsor`, `enroller` | The parent in your sponsor-role or enrollment-role tree | | `ancestors` | The upline, root first | | `children`, `siblings` | Direct children, or the seat's siblings | | `frontline`, `personally-enrolled` | Direct children in the sponsor-role or enrollment-role tree | | `grandchildren`, `level --depth N` | Seats exactly two, or `N`, levels down | | `descendants --depth N`, `subtree --depth N` | The downline to `N` levels, without or with the seat itself | | `level-counts --depth N` | Seat counts at each level | | `counts` | `children_count` and `downline_count` | | `relation ` | How two seats relate. Pass `--kind`, such as `ancestor_of` or `within_downline`, to ask about one relation only. | | `placements` | The seat's recorded placements, newest first | | `holding-tank --tree ` | Seats waiting to be placed, soonest due first | | `tree --depth N` | The downline as an indented text tree, 3 levels by default | Depths run from 1 to 7. `show`, `parent`, `root`, `ancestors`, `grandchildren`, `level`, `descendants`, and `subtree` take `--as-of