> ## 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 <token>; 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.
> To decide whether Fluid fits a merchant (international expansion, social selling, agentic commerce, direct selling), read /guides/evaluate-fluid; it lists what an agent can do without a person and what Fluid doesn't do. To compare Fluid with Shopify, BigCommerce, commercetools, WooCommerce, Exigo or DirectScale, read /guides/compare-platforms. Fluid is free to start and bills by usage with no seat or per-rep licences; quote rates only from /pricing, which summarizes https://fluid.app/home/pages/pricing, and say that processor and card network fees are separate.
> Every live Fluid storefront serves /llms.txt, /agents.md, .md and .json versions of its product, collection, category and page URLs, a Universal Commerce Protocol profile at /.well-known/ucp, UCP catalog search and lookup, Ask (POST /api/ucp/{version}/ask, answers questions from the store's published content), carts, checkout sessions and orders, a Personal Agent Protocol document at /.well-known/poppy.json, and an A2A Agent Card at /.well-known/agent-card.json with a JSON-RPC endpoint at /api/a2a. A checkout session completes inside the agent with Google Pay when the store's profile lists the com.google.pay payment handler; otherwise hand the shopper the continue_url to hosted checkout. A member's share link is /<username>/products/<slug>; see /concepts/agentic-commerce, /concepts/poppy, /concepts/ucp and /concepts/a2a.
> 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 site_deploy tool publishes server functions sent inline that import nothing; publish functions with imports, and convert a Site to an App, with the fluid sites CLI. A Site can serve light server code: each functions/<name>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/<name> on the Site's own host; publish it with fluid deploy, or inline through the MCP site_deploy tool when it imports nothing. 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.
> To create a URL redirect, create a custom route on the Sitemap: POST /api/theme_region_rules with redirect_type redirect, a redirect_url, region_code default, route_kind non_credit and redirect_status_code 301 or 302. See /themes/custom-routes#create-a-redirect-with-the-api. Never use /api/redirects; those legacy redirects are no longer used, and the admin's Sitemap screen doesn't show them.
> 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.

# List the playlists the rep may share

> Returns live company playlists (explicit company playlists, or owned by no one) available in the rep's country and, while content availability is on, to the rep's member type, newest first, each with the rep's credited share link and its title in the rep's language. This is the one audience rule `GET /api/member/v2027-01/storefront/search` and `POST /api/member/v2026-10/shares` apply. Responses are private and must be revalidated.



## OpenAPI

````yaml /api-reference/member-content-v2027-01.yaml get /api/member/v2027-01/storefront/playlists
openapi: 3.1.0
info:
  title: Fluid Member API v2027-01 — Storefront
  description: >
    The storefront the signed-in rep may share: one list per kind of storefront
    content (products, media,

    playlists, posts, pages, collections, categories, enrollment packs and
    sites) and one search across all

    of them. The rep's own media, playlists and shares stay on v2026-10. The
    member and company come from the

    bearer credential alone, which is resolved exactly as v2026-10 resolves it,
    and only rep-eligible

    memberships may use it: other memberships receive 403, as they do from `GET
    /api/member/v2026-10/media`.


    **One audience rule.** Every list, the search and `POST
    /api/member/v2026-10/shares` decide what the rep

    may see and share by the same rule: the company's content that is active and
    published now, available in

    the rep's country (their own, else the company's default; content listed for
    no country reaches every

    country) and, where the kind has a member-type gate (media, posts and
    playlists by content availability;

    products, collections and enrollment packs by product availability),
    available to the rep's member type.

    Media are the company's share library: share media, whoever at the company
    uploaded them, not restricted

    and not past their deactivation time. Playlists are company playlists. Sites
    are the active, public sites

    of the rep's site menu that are served now. Rank never decides what a rep
    sees.


    **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: 2027-01
servers:
  - url: https://api.fluid.app
    description: Production API server
  - url: https://api.fluid.test
    description: Local development server
security:
  - MemberBearer: []
tags:
  - name: storefront
    description: Storefront content the signed-in rep may share, and its search.
    x-fluid-section: Members
paths:
  /api/member/v2027-01/storefront/playlists:
    get:
      tags:
        - storefront
      summary: List the playlists the rep may share
      description: >-
        Returns live company playlists (explicit company playlists, or owned by
        no one) available in the rep's country and, while content availability
        is on, to the rep's member type, newest first, each with the rep's
        credited share link and its title in the rep's language. This is the one
        audience rule `GET /api/member/v2027-01/storefront/search` and `POST
        /api/member/v2026-10/shares` apply. Responses are private and must be
        revalidated.
      operationId: member_v202701_storefront_playlists_index
      parameters:
        - name: If-None-Match
          in: header
          required: false
          description: ETag from a previous response.
          schema:
            type: string
        - name: filter[q]
          in: query
          description: >-
            Only records whose title, in any language, contains this text,
            case-insensitively.
          schema:
            type: string
            minLength: 1
            maxLength: 200
          example: wellness
        - name: page[cursor]
          in: query
          description: >-
            Opaque cursor from `meta.pagination.next_cursor`. A cursor issued
            for other filters restarts at the first page; a malformed, tampered
            or expired one (older than three days) returns 400.
          schema:
            type: string
        - name: page[limit]
          in: query
          description: Maximum number of items returned.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          example: 25
      responses:
        '200':
          description: A page of the playlists the rep may share.
          headers:
            ETag:
              $ref: '#/components/headers/ETag'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontItemEnvelope'
              example:
                status: 200
                data:
                  - id: 0199a3f2-5c1e-7d4b-9a10-3b2c1d4e5f61
                    kind: playlists
                    title: Getting started
                    description: null
                    image_url: null
                    url: https://primex.fluid.app/home/libraries/getting-started
                    share_url: >-
                      https://primex.fluid.app/riley-kim/libraries/getting-started
                    created_at: '2026-09-29T15:02:11.482913Z'
                    updated_at: '2026-09-29T15:04:52.118204Z'
                meta:
                  request_uuid: 0199a3f2-7a10-7c3e-8f21-4d5e6f708193
                  timestamp: '2026-09-30T18:24:05Z'
                  pagination:
                    next_cursor: null
        '304':
          description: >-
            The representation is unchanged; authentication and access are
            checked before this response.
          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 or unusable member credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            The membership cannot share content (a customer), or the credential
            belongs to a sandbox test company that cannot be reached now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: >-
            A query parameter is not valid, such as a blank or over-long
            `filter[q]`, a `page[limit]` outside 1 to 100, or an undeclared
            parameter.
          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. Lists are private with max-age=0,
        so a client revalidates on every use; search responses are no-store.
      schema:
        type: string
        example: max-age=0, private
  schemas:
    StorefrontItemEnvelope:
      type: object
      description: A page of storefront records the rep may share.
      properties:
        status:
          type: integer
          description: HTTP response status.
        data:
          type: array
          description: The page's records, newest first.
          items:
            $ref: '#/components/schemas/StorefrontItem'
        meta:
          $ref: '#/components/schemas/PageMeta'
      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
          description: The error message and field-keyed details.
          properties:
            message:
              type: string
              description: Human-readable error message.
            details:
              type: object
              description: Field-keyed error details.
              additionalProperties: true
          required:
            - message
            - details
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - status
        - error
        - meta
    StorefrontItem:
      type: object
      description: One storefront record the rep may share.
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
          description: Public id of the record.
        kind:
          type: string
          description: The storefront kind the record is.
          enum:
            - products
            - playlists
            - posts
            - pages
            - collections
            - categories
            - enrollment-packs
            - sites
        title:
          type:
            - string
            - 'null'
          description: >-
            Title in the member's language when the record has that translation,
            otherwise its own title, then the default language's, then any.
        description:
          type:
            - string
            - 'null'
          description: >-
            Plain-text description in the member's language when the record has
            that translation, otherwise its own, then the default language's,
            then any.
        image_url:
          type:
            - string
            - 'null'
          description: The record's stored image; an enrollment pack's first image.
        url:
          type:
            - string
            - 'null'
          description: >-
            Canonical storefront URL (`/home/<kind>/<slug>`); a site's is
            `/home/sites/<slug>`, null while the sites gateway cannot serve it.
        share_url:
          type:
            - string
            - 'null'
          description: >-
            The member's untracked storefront link, crediting their username
            (`/<username>/<kind>/<slug>`). It is the address a tracked share
            (`POST /api/member/v2026-10/shares`) redirects to. Null without a
            username, and for a site the sites gateway cannot serve.
        created_at:
          type: string
          format: date-time
          description: When it was created.
        updated_at:
          type: string
          format: date-time
          description: When it last changed.
      required:
        - id
        - kind
        - title
        - description
        - image_url
        - url
        - share_url
        - created_at
        - updated_at
    PageMeta:
      description: Envelope metadata with the list's pagination state.
      allOf:
        - $ref: '#/components/schemas/ResponseMeta'
        - type: object
          properties:
            pagination:
              $ref: '#/components/schemas/PaginationMeta'
          required:
            - pagination
    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 member
        session JWT, a portal JWT whose login is linked to a membership in
        that company, or an opaque member token. The credential alone
        identifies the member and company.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.