> ## 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. # Member APIs > Which Fluid API to use for member data: the member API for a signed-in member's own identity and team, and the company API for managing members. A **member** is a person in a Fluid company — a customer, a rep, or a type the company defines. Fluid has two sets of member endpoints, and which one you use depends on **who is calling**: | You are building | Use | Credential | | - | - | - | | An app or portal where a member manages their own profile and team | The **member API**, `/api/member/v2026-10/...` | The member's own credential | | A back-office integration that manages a company's members | **Member management**, in the People section of the API reference | A company token | | A shopper account page in a checkout | The Checkout API's shopper endpoints | A shopper's token — see [Checkout](/api/choosing-a-cart-surface) | ## The member API The member API acts as the signed-in member. The credential alone decides which member and which company a request is about — no path, query, or body parameter ever names a member. ### Credentials Send the member's credential as a Bearer token to `https://api.fluid.app`: ```bash theme={null} curl "https://api.fluid.app/api/member/v2026-10/me" \ -H "Authorization: Bearer " ``` A member credential is a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The member API refuses, with `401`: * Company, partner, public (`pub-`), and droplet installation tokens. * Any credential belonging to a company admin — including an admin who is also a member of that company. * A credential for a member who is removed, inactive, or locked, or whose company is inactive. A JWT that can also travel in a URL is **read-only**: a write with it returns `403`. ### Identity and memberships | Operation | What it does | | - | - | | [Show the signed-in member](/api-reference/me/show-the-signed-in-member) | The member's own record | | [Update the signed-in member](/api-reference/me/update-the-signed-in-member) | Change the member's own details | | [List the user's memberships](/api-reference/companies/list-the-users-memberships) | Every company the same person is a member of, for a company switcher | ### Team A member can read their own team — the part of their company's genealogy below them — and request moves within it: | Operation | What it does | | - | - | | [Read a team seat](/api-reference/genealogy-history/read-recorded-relationship-for-member-access) | One seat in the member's team, with its recorded relationship | | [Page children](/api-reference/genealogy-reads/page-current-team-children), [descendants](/api-reference/genealogy-reads/page-current-team-descendants), [subtree](/api-reference/genealogy-reads/page-current-team-subtree), and [one level](/api-reference/genealogy-reads/page-one-current-team-relative-level) | Walk the team, one cursor page at a time | | [Count seats by level](/api-reference/genealogy-reads/count-current-team-structural-seats-by-relative-level) | Team size at each level below a seat | | [Preview](/api-reference/genealogy-moves/preview-a-member-genealogy-move) and [request](/api-reference/genealogy-moves/request-a-member-genealogy-move) a move | Check a move, then submit it | | [List](/api-reference/genealogy-moves/list-own-move-requests) and [withdraw](/api-reference/genealogy-moves/withdraw-an-own-move-request) move requests | Track the member's own requests | * **Team reads are limited to the member's current team.** A member never sees seats outside it. * **Moves take effect on the server's clock.** An immediate move returns `200`. A move that needs approval, or runs later as a job, returns `202` with a receipt you can follow. * **A company has to enable moves.** Until it does, move requests are refused. The team endpoints accept a member or customer session JWT, or a member's user token. Company tokens are refused. The member API currently covers identity, memberships, and team. Other member data — such as a member's orders or contacts — isn't available through it yet. ## Member management These endpoints are in the **People** section of the API reference, under **Members**. A company manages its members with a company token that has the `members` permission: | Operation | What it does | | - | - | | [List members](/api-reference/members/list-members) and [find a member](/api-reference/members/find-a-member-by-a-unique-identifier) | Search the company's members | | [Create](/api-reference/members/create-a-member), [get](/api-reference/members/get-a-member), and [update](/api-reference/members/update-a-member) a member | Manage one member | | [Change a member's type](/api-reference/members/change-a-members-type) | Move a member between customer, rep, and your own types | | [Get a member's sponsor genealogy](/api-reference/members/get-a-members-sponsor-genealogy) | A member's sponsor line. A rep can also call this for their own downline. | Use these endpoints rather than the older customer and member endpoints listed with them when the member's type matters: only member management returns `member_type`. To manage the company's genealogy trees themselves — defining trees, placing members, and approving moves — use the **Genealogy** endpoints in the **People** section of the API reference, with a company token. ## Related * [Authentication](/api/authentication) — company tokens and permissions. * [Choosing a cart surface](/api/choosing-a-cart-surface) — shopper endpoints in checkout.