> ## 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. # Company and member APIs > Fluid has company APIs, which act for a whole company, and member APIs, which act for one signed-in member using that member's own JWT. Learn which to call and with which credential. Every authenticated Fluid endpoint acts for one of two callers: a **company** or a **member**. The caller decides which endpoints you use, which credential you send, and what data you can reach. | | Company APIs | Member APIs | | - | - | - | | Acts for | The whole company | One signed-in member | | Who can call | Company admins whose role grants the permission, partner tokens, and droplet installation tokens | Only the member, with their own JWT | | Can reach | Any of the company's data its permissions or scopes allow | Only that member's own data | | Paths | For example `/api/v202604/company/...` and `/api/company/v2026-10/...` | `/api/member/v2026-10/...` | | Typical use | Back-office integrations, droplets, data sync | Member apps, portals, and back offices where a member manages their own account | A third group of endpoints — [public storefront reads](/storefront/public-and-company-endpoints) and [checkout](/api/choosing-a-cart-surface) — takes no company or member credential at all. ## Company APIs Company endpoints act for the company the credential belongs to. Only three kinds of caller can use them: * **A company admin whose role grants the permission** — through a company token or the admin's own sign-in. An admin whose role lacks the permission gets `403`. * **A partner token**, which acts with the role it was created with. * **A droplet installation token**, limited to the scopes granted to the droplet's installation. Members and shoppers can't call company endpoints. A public (`pub-`) token reaches only the few endpoints its scopes cover, such as product reads and DAM uploads. Within what its role or scopes allow, a caller can reach any record of that company. See [Authentication](/api/authentication) for the token types. Company endpoints can manage members too — for example, listing members or changing a member's type. They do that **as the company**, on any member it chooses. ## Member APIs Member endpoints act **as the member**. Two rules follow from that: * **They are scoped to the member.** The JWT identifies the member and their company. No path, query, or body parameter names a member, so a member can only ever reach their own profile, memberships, and team. * **They use that member's JWT.** Send the member's own credential as a Bearer token. A company, partner, public (`pub-`), or droplet installation token is refused with `401` — even though it can see far more data, it doesn't speak for a member. A company admin's credential is refused as well. ```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. A JWT that can also travel in a URL is read-only: a write with it returns `403`. ## Choosing one * **Your code runs for the company** — a sync job, a droplet, an admin tool: use company endpoints with an admin's token (with the right role), a partner token, or a droplet installation token. * **Your code runs for a signed-in member** — they should see and change only their own data: use member endpoints with that member's JWT. * **Never** hand a company token to a member's browser or app to fetch "their" data. It can read every member's data. Use the member's own JWT so Fluid enforces the scope for you. See [Member APIs](/api/member-apis) for every member endpoint.