> ## 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. # Modify a tree definition > Company admin access is required. Writes require developer.update. Droplet installation tokens are not supported. This registry API does not place or move members. Default role trees cannot be removed or have their role cleared. The example uses illustrative fixture IDs. Substitute records visible to your authenticated company or member. ## OpenAPI ````yaml /api-reference/genealogy-v2026-10.yaml patch /api/company/v2026-10/genealogy/trees/{id} 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. - name: Genealogy placement description: Place members in binary and matrix trees and manage their holding tank. paths: /api/company/v2026-10/genealogy/trees/{id}: patch: tags: - Genealogy trees summary: Modify a tree definition description: >- Company admin access is required. Writes require developer.update. Droplet installation tokens are not supported. This registry API does not place or move members. Default role trees cannot be removed or have their role cleared. The example uses illustrative fixture IDs. Substitute records visible to your authenticated company or member. operationId: modifyGenealogyTree parameters: - in: path name: id required: true description: Identifier of a tree owned by the authenticated company. schema: type: string format: uuid example: 9b7310f6-6dac-5a77-9726-21c9fade457a requestBody: required: true description: >- Tree definition fields. Ownership must be declared explicitly on creation. content: application/json: schema: $ref: '#/components/schemas/UpdateTree' example: tree: name: Sales Team lock_version: 0 examples: recorded: summary: Modify a tree definition value: tree: lock_version: 1 allow_multiple_positions: false volume_key: null responses: '200': description: Modify a tree definition. content: application/json: schema: $ref: '#/components/schemas/TreeResponse' examples: recorded: summary: Modify a tree definition. value: tree: allow_multiple_positions: false authority: unconfigured created_at: '2026-09-10T03:03:10Z' default_placement_rule: under_enroller external_integration_market_id: null holding_tank_days: 0 id: 9b7310f6-6dac-5a77-9726-21c9fade457a key: enrollment kind: unilevel leg_names: [] lock_version: 2 max_depth: 300 max_movement_levels: 0 movement_approval: immediate movement_window_days: 0 name: Enrollment owning_company_integration_id: null role: enrollment updated_at: '2026-09-10T03:03:17Z' upstream_tree_ref: null volume_key: null volume_on_move: null status: 200 meta: request_uuid: null timestamp: '2026-09-10T03:03:17Z' '401': description: Missing or invalid credentials. content: application/json: schema: $ref: '#/components/schemas/AuthError' '403': description: >- Company admin tier or developer permission is missing, or a droplet installation token was supplied. content: application/json: schema: $ref: '#/components/schemas/AuthError' '404': description: No tree with this identifier belongs to this company. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- Tree key or role already exists, the supplied version is stale, or the tree has nodes and the change is structural. Only the name of an occupied tree can change; details.type is tree_has_nodes. content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- Invalid input or a required ownership, volume or role rule was violated. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: Shell label: Modify a tree definition source: >- curl -X PATCH 'https://api.fluid.app/api/company/v2026-10/genealogy/trees/9b7310f6-6dac-5a77-9726-21c9fade457a' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data \{\"tree\":\{\"lock_version\":1,\"allow_multiple_positions\":false,\"volume_key\":null\}\} components: schemas: UpdateTree: type: object properties: tree: type: object description: Include lock_version and at least one tree attribute to update. minProperties: 2 properties: key: type: string description: >- Case-insensitive key unique within the company. The enrollment and placement keys require the enrollment and sponsor roles respectively. Default roles also require these keys; change the name for display customization. minLength: 1 name: type: string description: Display name. minLength: 1 kind: type: string description: >- Declared tree shape; placement strategies are delivered separately. enum: - unilevel - binary - matrix role: type: - string - 'null' description: >- Required default axis role. Once assigned, it cannot be cleared or changed. enum: - enrollment - sponsor - null leg_names: type: array description: >- Ordered leg labels: none for unilevel, two for binary, at least two for matrix. Binary creation defaults to left and right. items: type: string minLength: 1 uniqueItems: true default_placement_rule: type: string description: Stored default for the later placement service. enum: - exact - first_empty - left - right - inside - outside - weak_leg - strong_leg - balanced - enroller_preference - defer - under_enroller - mirror_enrollment volume_key: type: - string - 'null' description: Volume key used by later leg placement rules. volume_on_move: type: - string - 'null' description: >- Required for binary and matrix trees; the compensation owner must choose it explicitly. enum: - follows_structure - stays_at_earning - null max_depth: type: integer description: Maximum allowed depth for later structural writes. minimum: 1 holding_tank_days: type: integer description: Days before later holding-tank expiry; zero disables it. minimum: 0 movement_window_days: type: integer description: Representative move window; zero disables representative moves. minimum: 0 movement_approval: type: string description: Approval policy for later representative moves. enum: - immediate - require_approval max_movement_levels: type: integer description: Movement level limit; zero means unlimited. minimum: 0 allow_multiple_positions: type: boolean description: Whether the later matrix placement service may allow re-entry. authority: type: string description: >- Explicit ownership declaration. Defaults seed unconfigured and do not claim Fluid ownership. enum: - unconfigured - authoritative - replica owning_company_integration_id: type: - integer - 'null' description: >- External fluid-integrations reference, required for replicas; not proof of integration authentication. minimum: 1 upstream_tree_ref: type: - string - 'null' description: Upstream tree identifier from the ownership manifest. external_integration_market_id: type: - string - 'null' description: Upstream market identifier. lock_version: type: integer description: >- Optimistic concurrency version; PATCH must send the version last read. minimum: 0 required: - lock_version additionalProperties: false required: - tree TreeResponse: type: object properties: status: type: integer tree: $ref: '#/components/schemas/Tree' meta: $ref: '#/components/schemas/Meta' required: - status - tree - meta 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 Tree: type: object properties: id: type: string description: Tree identifier. format: uuid key: type: string description: >- Case-insensitive key unique within the company. The enrollment and placement keys require the enrollment and sponsor roles respectively. Default roles also require these keys; change the name for display customization. minLength: 1 name: type: string description: Display name. minLength: 1 kind: type: string description: Declared tree shape; placement strategies are delivered separately. enum: - unilevel - binary - matrix role: type: - string - 'null' description: >- Required default axis role. Once assigned, it cannot be cleared or changed. enum: - enrollment - sponsor - null leg_names: type: array description: >- Ordered leg labels: none for unilevel, two for binary, at least two for matrix. Binary creation defaults to left and right. items: type: string minLength: 1 uniqueItems: true default_placement_rule: type: string description: Stored default for the later placement service. enum: - exact - first_empty - left - right - inside - outside - weak_leg - strong_leg - balanced - enroller_preference - defer - under_enroller - mirror_enrollment volume_key: type: - string - 'null' description: Volume key used by later leg placement rules. volume_on_move: type: - string - 'null' description: >- Required for binary and matrix trees; the compensation owner must choose it explicitly. enum: - follows_structure - stays_at_earning - null max_depth: type: integer description: Maximum allowed depth for later structural writes. minimum: 1 holding_tank_days: type: integer description: Days before later holding-tank expiry; zero disables it. minimum: 0 movement_window_days: type: integer description: Representative move window; zero disables representative moves. minimum: 0 movement_approval: type: string description: Approval policy for later representative moves. enum: - immediate - require_approval max_movement_levels: type: integer description: Movement level limit; zero means unlimited. minimum: 0 allow_multiple_positions: type: boolean description: Whether the later matrix placement service may allow re-entry. authority: type: string description: >- Explicit ownership declaration. Defaults seed unconfigured and do not claim Fluid ownership. enum: - unconfigured - authoritative - replica owning_company_integration_id: type: - integer - 'null' description: >- External fluid-integrations reference, required for replicas; not proof of integration authentication. minimum: 1 upstream_tree_ref: type: - string - 'null' description: Upstream tree identifier from the ownership manifest. external_integration_market_id: type: - string - 'null' description: Upstream market identifier. lock_version: type: integer description: >- Optimistic concurrency version; PATCH must send the version last read. minimum: 0 created_at: type: string description: Creation timestamp. format: date-time updated_at: type: string description: Last modification timestamp. format: date-time required: - id - key - name - kind - role - leg_names - default_placement_rule - volume_key - volume_on_move - max_depth - holding_tank_days - movement_window_days - movement_approval - max_movement_levels - allow_multiple_positions - authority - owning_company_integration_id - upstream_tree_ref - external_integration_market_id - lock_version - created_at - updated_at 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. ````