> ## 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. # List the user's memberships > Every membership the signed-in member's user holds, the credential's own included, so a client can offer a company switcher. A company the user administers is listed too, with its admin roles. Removed memberships and removed companies never appear. Sorted by company name in the database's collation order (not lowercased), companies without a name last, then by membership id. A cursor is bound to the query that issued it: one sent with other `filter` values, or by another user, is ignored and the first page is returned. ## OpenAPI ````yaml /api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/companies openapi: 3.1.0 info: title: Fluid Member API v2026-10 — People description: > The signed-in member's own identity, and the memberships their user holds across companies. Every operation acts as the member the bearer credential speaks for: the member and their company come from the credential alone, never from a path, query or body parameter. A member credential is a member session JWT, a portal JWT whose user company login is linked to a membership in that company, or a member token. Company, partner, public and droplet tokens are refused with 401, as are an admin's token, an admin's or root admin's portal JWT, any credential for a member who is also an admin of that company (their own member session JWT and member token included), a portal JWT with no membership linked to it, and a credential for a member who is removed, inactive or locked, whose user is deleted, or whose company is inactive. 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: me description: The signed-in member's own identity - name: profile description: The signed-in member's shared public profile - name: companies description: The memberships the signed-in member's user holds, for a company switcher paths: /api/member/v2026-10/companies: get: tags: - companies summary: List the user's memberships description: | Every membership the signed-in member's user holds, the credential's own included, so a client can offer a company switcher. A company the user administers is listed too, with its admin roles. Removed memberships and removed companies never appear. Sorted by company name in the database's collation order (not lowercased), companies without a name last, then by membership id. A cursor is bound to the query that issued it: one sent with other `filter` values, or by another user, is ignored and the first page is returned. operationId: member_companies_index parameters: - name: filter[active] in: query required: false description: | `true` (the default) lists the memberships whose `active` is true; `false` lists the rest: inactive, locked, or in an inactive company. schema: type: boolean example: true - name: page[cursor] in: query required: false description: | Opaque cursor from a previous response's `meta.pagination.next_cursor`. Omit for the first page. A cursor that is malformed, tampered with or older than three days returns 400; start again from the first page. 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 example: 25 responses: '200': description: One page of the user's memberships. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/MembershipsEnvelope' example: status: 200 data: - id: 0192f3a8-5c1e-7d42-9b6a-3e8f1c2d4a57 company: id: 0192f39f-7a3b-7c21-a8e4-1d6b9f3c5e82 name: Dunder Mifflin Paper Company subdomain: dunder-mifflin logo_url: https://cdn.fluid.app/companies/dunder-mifflin/logo.png icon_url: https://cdn.fluid.app/companies/dunder-mifflin/icon.png primary_color: 1F4E8C member_type: id: 0192f3a1-2b7d-7e10-8c4f-5a9d2e6b1f03 slug: rep name: Brand Partner roles: [] active: true current: true joined_at: '2026-09-02T14:31:07Z' - id: 0192f3b4-6f8a-7b93-9d2c-4e5f6a7b8c90 company: id: 0192f3b0-8c1d-7e45-a6f7-2b3c4d5e6f71 name: Hooli subdomain: hooli logo_url: https://cdn.fluid.app/companies/hooli/logo.png icon_url: null primary_color: 2E9E4F member_type: id: 0192f3b1-4d5e-7f60-b7a8-3c4d5e6f7a82 slug: customer name: Customer roles: [] active: true current: false joined_at: '2026-09-14T09:12:48Z' meta: request_uuid: 0192f4c8-5b6c-7d74-c3e8-0f1a2b3c4d5e timestamp: '2026-09-30T15:08:21Z' pagination: next_cursor: null '304': description: The 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 expired. 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' '422': description: >- A query parameter is not valid, such as a non-boolean `filter[active]` or a `page[limit]` outside 1 to 100. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: headers: ETag: description: >- Fingerprint of this member's representation. Send it back in If-None-Match to skip the body while it is unchanged. schema: type: string CacheControl: description: Standard HTTP Cache-Control directive. Always private for this surface. schema: type: string example: max-age=60, private schemas: MembershipsEnvelope: type: object properties: status: type: integer data: type: array items: $ref: '#/components/schemas/Membership' meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: pagination: $ref: '#/components/schemas/PaginationMeta' required: - pagination required: - status - data - meta 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 Membership: type: object description: One membership the signed-in member's user holds. additionalProperties: false properties: id: type: string format: uuid description: The membership's identifier (not the company's). company: $ref: '#/components/schemas/MembershipCompany' member_type: description: | The membership's type in that company. Nullable so that a membership that exists only because the user is an admin of that company (typed `customer` as of v2026-10) can report null without a contract change. Use `roles` to tell admins apart. oneOf: - $ref: '#/components/schemas/MemberTypeReference' - type: 'null' roles: type: array description: >- The user's admin role slugs in that company; empty when they are not an admin there. items: type: string example: - admin active: type: boolean description: | Whether the membership's own state lets it act: not inactive (a grace period counts), not locked, and in an active company. A member credential for it may still be refused, for example when the user is also an admin of that company. current: type: boolean description: Whether this is the membership the request's credential speaks for. joined_at: type: string format: date-time description: When the membership was created. required: - id - company - member_type - roles - active - current - joined_at 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 MembershipCompany: type: object description: >- The company a membership belongs to, with what a switcher needs to render it. additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' example: Dunder Mifflin Paper Company subdomain: type: - string - 'null' example: dunder-mifflin logo_url: type: - string - 'null' format: uri icon_url: type: - string - 'null' format: uri primary_color: type: - string - 'null' description: The company's brand color, as hex without a leading `#`. example: 0C7CF6 required: - id - name - subdomain - logo_url - icon_url - primary_color MemberTypeReference: type: object description: The member's type within their company. additionalProperties: false properties: id: type: string format: uuid slug: type: string example: rep name: type: string example: Brand Partner required: - id - slug - name securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, 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. ````