> ## 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. > To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. A Site can serve light server code: each functions/.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/ on the Site's own host; publish it with fluid deploy (the MCP site_deploy tool does not carry functions). See /sites/functions and /sites/rest-api. > 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. # Count the Team by member type, rank and activity > The signed-in member's current Team counted by member type, by rank and by activity status. The Team is the one `GET /api/member/v2026-10/team` lists, found the same way, over the same five levels, so `total_count` equals the summary's. The labels are the ones the list already shows for each Team member; no Team member is named. A member with no downline gets zeros. In a company on tree reads, a member with no seat in the enrollment tree gets 404, as in the list. The same members may read it as may read the summary, the legacy My Team `authorize_rep_tier`: reps, company admins and root admins, on a member token or portal JWT. A customer or preferred-customer membership is refused with 403, even with a valid credential, as is a member session JWT. No parameter selects another member: the Team is always the credential's own. Current Team membership is rechecked on every request, so the response is private and must be revalidated before reuse. ## OpenAPI ````yaml /api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team/composition openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Team description: | The signed-in member's current Team: their downline, read as the legacy My Team does. Every operation acts as the member the bearer credential speaks for; the member and their company come from the credential alone, and no path, query or body parameter can widen either. Team reads are rechecked against the member's current Team on every request, so responses are private and must be revalidated before reuse. A member moved out of the Team disappears on the next read. Each Team member's `id` is their member id. Seats are a separate address space: the seat detail (`GET /api/member/v2026-10/team/{id}`) and the Team tree, move and move-request operations take seat ids and are documented with the genealogy API. **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: team description: The signed-in member's current Team, their downline. x-fluid-section: Members paths: /api/member/v2026-10/team/composition: get: tags: - team summary: Count the Team by member type, rank and activity description: > The signed-in member's current Team counted by member type, by rank and by activity status. The Team is the one `GET /api/member/v2026-10/team` lists, found the same way, over the same five levels, so `total_count` equals the summary's. The labels are the ones the list already shows for each Team member; no Team member is named. A member with no downline gets zeros. In a company on tree reads, a member with no seat in the enrollment tree gets 404, as in the list. The same members may read it as may read the summary, the legacy My Team `authorize_rep_tier`: reps, company admins and root admins, on a member token or portal JWT. A customer or preferred-customer membership is refused with 403, even with a valid credential, as is a member session JWT. No parameter selects another member: the Team is always the credential's own. Current Team membership is rechecked on every request, so the response is private and must be revalidated before reuse. operationId: member_team_composition parameters: - name: If-None-Match in: header required: false description: >- A previously returned ETag. Authentication and the current Team read run before a 304 is considered. schema: type: string responses: '200': description: The member's Team composition. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/TeamCompositionEnvelope' example: status: 200 data: total_count: 27 by_member_type: - slug: customer name: Customer count: 18 - slug: rep name: Brand Partner count: 9 by_rank: - name: null count: 20 - name: Associate count: 6 - name: Leader count: 1 by_activity_status: - status: active count: 21 - status: grace_period count: 2 - status: inactive count: 4 meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-11-11T15:04:05Z' '304': description: The counts have not changed since the supplied ETag. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '401': description: >- Missing credential, or a credential that is not a usable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- The credential is a member session JWT, the kind order and subscription email links carry, which cannot read the Team, or the membership is a customer or preferred customer, which has no Team. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: The company reads its Team from trees and the member has no seat. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: The request carries a query parameter; the composition takes none. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: headers: ETag: description: >- Fingerprint of this member's current representation. Send it back in If-None-Match; the server reads the member's current Team before answering 304. schema: type: string CacheControl: description: >- Standard HTTP Cache-Control directive. Team reads are private and revalidated on every use. schema: type: string example: max-age=0, private schemas: TeamCompositionEnvelope: type: object description: The signed-in member's Team composition. required: - status - data - meta properties: status: type: integer data: $ref: '#/components/schemas/TeamComposition' meta: $ref: '#/components/schemas/ResponseMeta' ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta TeamComposition: type: object description: >- The signed-in member's Team, over the same members and five levels as the Team list and summary, counted by member type, rank and activity status. Counts only: no Team member is named. additionalProperties: false required: - total_count - by_member_type - by_rank - by_activity_status properties: total_count: type: integer minimum: 0 description: Team members counted. Each list below sums to it. by_member_type: type: array description: >- Team members per member type, largest count first, then by name. Types with no members are left out. items: type: object additionalProperties: false required: - slug - name - count properties: slug: type: - string - 'null' description: The member type's slug, as the Team list's `member_type.slug`. name: type: - string - 'null' description: The member type's name, as the Team list's `member_type.name`. count: type: integer minimum: 1 description: Team members of this member type. by_rank: type: array description: >- Team members per rank, largest count first, then by name. Members with no rank count under a null name. Ranks with no members are left out. items: type: object additionalProperties: false required: - name - count properties: name: type: - string - 'null' description: >- The rank's name, as the Team list's `rank.name`, or null for members with no rank. count: type: integer minimum: 1 description: Team members at this rank. by_activity_status: type: array description: >- Team members per activity status. Always three entries, in this order, zeros included. minItems: 3 maxItems: 3 items: type: object additionalProperties: false required: - status - count properties: status: type: string enum: - active - grace_period - inactive description: >- The member's activity status. The Team list reports `active: true` for `active` and `active: false` for the other two. count: type: integer minimum: 0 description: Team members in this activity status. 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 securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company. A member session JWT, the kind order and subscription email links carry, is refused with 403, as legacy My Team needs a rep session. A customer or preferred-customer membership is refused with 403 too: legacy My Team (`authorize_rep_tier`) admits reps, company admins and root admins. A company admin's own credential is not a member credential and gets 401, so in practice a rep's or a root admin's membership reads the Team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.