> ## 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 the member's Team > The members below the signed-in member, nearest level first, then by join time and member id. Direct reports by default; `filter[depth]` reaches up to five levels further, and `filter[under]` pages beneath one Team member, again up to five levels below that member. Every member type is included. Members who were removed are not listed, and nor is anyone below a removed member. A company reads its Team from the enrollment tree when it has tree reads enabled and from the enroller relation otherwise, as the legacy My Team does. A member with no downline has an empty Team; in a company on tree reads, a member with no seat in the enrollment tree gets 404, as in the legacy My Team. The Team follows the legacy My Team rule (`authorize_rep_tier`): reps, company admins and root admins. A company admin credential is not a member credential and gets 401, so in practice a rep's membership reads the Team on a member token or portal JWT, and a root admin's membership on a member token only: a portal JWT signed for an admin or root admin login is refused with 401. A customer or preferred-customer membership is refused with 403, even with a valid credential, as is a member session JWT. Current Team membership is rechecked on every request and every cursor, so a member moved out of the Team disappears from the next page. ## OpenAPI ````yaml /api-reference/member-team-v2026-10.yaml get /api/member/v2026-10/team 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. 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: get: tags: - team summary: List the member's Team description: > The members below the signed-in member, nearest level first, then by join time and member id. Direct reports by default; `filter[depth]` reaches up to five levels further, and `filter[under]` pages beneath one Team member, again up to five levels below that member. Every member type is included. Members who were removed are not listed, and nor is anyone below a removed member. A company reads its Team from the enrollment tree when it has tree reads enabled and from the enroller relation otherwise, as the legacy My Team does. A member with no downline has an empty Team; in a company on tree reads, a member with no seat in the enrollment tree gets 404, as in the legacy My Team. The Team follows the legacy My Team rule (`authorize_rep_tier`): reps, company admins and root admins. A company admin credential is not a member credential and gets 401, so in practice a rep's membership reads the Team on a member token or portal JWT, and a root admin's membership on a member token only: a portal JWT signed for an admin or root admin login is refused with 401. A customer or preferred-customer membership is refused with 403, even with a valid credential, as is a member session JWT. Current Team membership is rechecked on every request and every cursor, so a member moved out of the Team disappears from the next page. operationId: member_team_index 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 - name: filter[under] in: query required: false description: >- A Team member's id to page beneath. A member outside the signed-in member's downline returns 404, and so does one the enrollment tree does not place below the signed-in member in a company on tree reads. schema: type: string format: uuid - name: filter[depth] in: query required: false description: >- Levels below the signed-in member, or below `filter[under]`, to include. schema: type: integer minimum: 1 maximum: 5 default: 1 - name: page[cursor] in: query required: false description: >- Opaque cursor from `meta.pagination.next_cursor`, valid only with the same filters and member. A malformed, tampered or mismatched cursor returns 400. schema: type: string - name: page[limit] in: query required: false description: Page size. Defaults to 25, at most 100. schema: type: integer minimum: 1 maximum: 100 default: 25 responses: '200': description: A page of the member's current Team. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/TeamEnvelope' example: status: 200 data: - id: 01a08944-eff4-7a2a-be01-d699fa649966 display_name: Nathan Rivera avatar_url: null username: nathan-rivera member_type: slug: rep name: Brand Partner rank: name: Silver level: 1 sponsor_id: 01a08944-eff0-7a2a-be01-d699fa649960 joined_at: '2026-03-14T18:22:05Z' active: true has_children: true email: nathan@example.com phone: '+15555550123' meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-01T15:04:05Z' pagination: next_cursor: null '304': description: >- The member's current Team page has not changed since the supplied ETag. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '400': description: >- The pagination cursor is malformed, tampered with or was issued for other filters. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '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: >- `filter[under]` is not in the current Team, or the company reads its Team from trees and the member has no seat, or the tree does not place `filter[under]` below the member. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: A query parameter is invalid or unknown. 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: TeamEnvelope: type: object description: A page of Team members. required: - status - data - meta properties: status: type: integer data: type: array description: Team members, nearest level first, then by join time and member id. items: $ref: '#/components/schemas/TeamMember' meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object required: - pagination properties: pagination: $ref: '#/components/schemas/PaginationMeta' 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 TeamMember: type: object description: >- One member of the signed-in member's Team. `email` and `phone` are shown to reps, as legacy My Team shows them; for any other member they are omitted, not null. additionalProperties: false required: - id - display_name - avatar_url - username - member_type - rank - level - sponsor_id - joined_at - active - has_children properties: id: type: string format: uuid description: The member's id. Use it as `filter[under]`. display_name: type: - string - 'null' description: >- The member's stored name, or their first and last name when it is blank. avatar_url: type: - string - 'null' description: The member's avatar image, when they have one. username: type: - string - 'null' description: The member's MySite username. member_type: type: object description: The member's type within the company. additionalProperties: false required: - slug - name properties: slug: type: string description: Stable member type key. name: type: string description: Display name of the member type. rank: type: - object - 'null' description: The member's rank, or null when unranked. additionalProperties: false required: - name properties: name: type: - string - 'null' description: Rank name. level: type: integer minimum: 1 description: >- Levels below the signed-in member; 1 is a direct report. A company on tree reads counts enrollment-tree steps, any other company sponsor steps. Pages anchored with `filter[under]` can reach deeper than 5. sponsor_id: type: string format: uuid description: >- The id of the member directly above this one: their enroller, or in a company that reads its Team from trees, their parent in the enrollment tree. It is the signed-in member or a member beneath them, or the `filter[under]` member for the first level of an anchored page. joined_at: type: string format: date-time description: When the member joined the company. active: type: boolean description: Whether the membership's activity status is active. has_children: type: boolean description: >- Whether this member has a kept member directly below them, including one beyond the levels this page reads. email: type: - string - 'null' description: Present only for a rep. phone: type: - string - 'null' description: Present only for a rep. 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 PaginationMeta: type: object description: Keyset pagination state for a list. additionalProperties: false properties: next_cursor: type: - string - 'null' description: Send as `page[cursor]` for the next page; null on the last page. required: - next_cursor 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.