> ## 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. # Search the storefront catalogue > Returns ranked hits across the company's public products, enrollment packs, pages, media, playlists and posts: only what the public storefront lists. Facets count the matching results of each requested type. Available to every membership, limited to 30 searches per minute per credential. Responses are never stored. ## OpenAPI ````yaml /api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/search openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Content description: >- The signed-in member's own media and playlists: list, read, write, and delete. The bearer credential determines the member and company. Only rep-eligible memberships may use these endpoints; other memberships receive 403. Foreign, deleted, and malformed identifiers return 404. Uploads, media creation, and playlist items are separate operations outside this contract. 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: media description: The signed-in member's own uploaded media. x-fluid-section: Members - name: playlists description: Ordered collections of media the member assembles to share. x-fluid-section: Members - name: shares description: Tracked links the member created, and what happened to them. x-fluid-section: Members - name: playlist-items description: Items and ordering in a member-owned playlist. x-fluid-section: Members - name: search description: Ranked search across the company's public storefront catalogue. x-fluid-section: Members paths: /api/member/v2026-10/search: get: tags: - search summary: Search the storefront catalogue description: >- Returns ranked hits across the company's public products, enrollment packs, pages, media, playlists and posts: only what the public storefront lists. Facets count the matching results of each requested type. Available to every membership, limited to 30 searches per minute per credential. Responses are never stored. operationId: member_search_index parameters: - name: q in: query required: true description: Search text, 2 to 200 characters. schema: type: string minLength: 2 maxLength: 200 - name: types in: query description: >- Comma-separated types to search: products, enrollment-packs, pages, media, playlists or posts. All six by default. schema: type: string maxLength: 200 example: products,media - name: page[cursor] in: query description: >- Opaque cursor from meta.pagination.next_cursor. Expires after one hour and only continues the same query and types. A catalogue reindex between pages invalidates it with a 400; repeat the search without a cursor. schema: type: string - name: page[limit] in: query description: Maximum number of hits returned. schema: type: integer minimum: 1 maximum: 50 default: 25 responses: '200': description: A page of hits. headers: Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/SearchEnvelope' example: status: 200 data: - kind: products id: 0199a3f2-5c1e-7d4b-9a10-3b2c1d4e5f61 title: Primex Wellness Kit image_url: https://ik.imagekit.io/fluid/primex/wellness-kit.jpg url: https://primex.fluid.app/home/products/primex-wellness-kit share_url: >- https://primex.fluid.app/riley-kim/products/primex-wellness-kit snippet: Everything you need for a 30-day wellness reset. score: 12.4 meta: request_uuid: 0199a3f2-7a10-7c3e-8f21-4d5e6f708192 timestamp: '2026-09-30T18:24:05Z' facets: products: 1 media: 0 pagination: next_cursor: null '400': description: >- Malformed, tampered or expired pagination cursor, or one from before a catalogue reindex. Repeat the search without a cursor. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/Invalid' '429': description: >- The credential has searched more than 30 times in the current minute. Wait `retry_after` seconds before searching again. Unlike other responses it carries no Cache-Control header. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/RateLimitError' example: error: Rate limit exceeded message: Too many requests. Please wait before trying again. retry_after: 42 '503': description: Search is unavailable; retry shortly. headers: Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: status: 503 error: message: Search is unavailable; retry shortly details: error: unavailable meta: request_uuid: 0199a3f2-7a10-7c3e-8f21-4d5e6f708193 timestamp: '2026-09-30T18:24:06Z' components: headers: CacheControl: description: >- Standard HTTP Cache-Control directive. Private for member reads; no-store for search and uploads. Media reads send max-age=0, so a client revalidates with If-None-Match on every use. schema: type: string example: max-age=0, private RateLimitLimit: description: Searches allowed per minute for this credential. schema: type: string example: '30' RateLimitRemaining: description: Searches left in the current minute; always 0 on a refused request. schema: type: string example: '0' RateLimitReset: description: >- When the current minute ends and the credential's search budget is restored, as a UTC timestamp. schema: type: string example: 2026-09-30 18:25:00 UTC schemas: SearchEnvelope: type: object description: One page of search results. properties: status: type: integer description: HTTP response status. data: type: array description: Hits, best match first. items: $ref: '#/components/schemas/SearchHit' meta: $ref: '#/components/schemas/SearchMeta' 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 RateLimitError: type: object description: >- The rate limiter's refusal. It is sent before the request reaches the API, so it has no status, error or meta envelope. properties: error: type: string description: Always `Rate limit exceeded`. example: Rate limit exceeded message: type: string description: Human-readable explanation. example: Too many requests. Please wait before trying again. retry_after: type: integer minimum: 1 description: Seconds until the credential's search budget is restored. example: 42 required: - error - message - retry_after SearchHit: type: object description: One ranked catalogue result. additionalProperties: false properties: kind: type: string description: Catalogue type of the result. enum: - products - enrollment-packs - pages - media - playlists - posts id: type: string format: uuid description: Public id of the result. title: type: - string - 'null' description: Title of the result. image_url: type: - string - 'null' description: Stored image, when the type stores one. url: type: - string - 'null' description: >- Canonical storefront URL, built from the result's slug. An enrollment pack without a slug uses its token instead; null when the result has neither. share_url: type: - string - 'null' description: >- The member's untracked storefront link crediting their username, built from the same slug or enrollment pack token as url; null without a username, or when the result has neither a slug nor a token. snippet: type: - string - 'null' description: Plain-text excerpt of the description, up to 200 characters. score: type: - number - 'null' description: Relevance score; comparable within one response only. required: - kind - id - title - image_url - url - share_url - snippet - score SearchMeta: description: Envelope metadata with per-type facets and the search cursor. allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: facets: type: object description: >- Number of matching results of each requested type, counted in the search itself. A result changed since it was last indexed can be counted before the index catches up. additionalProperties: type: integer pagination: $ref: '#/components/schemas/PaginationMeta' required: - facets - 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 responses: Unauthorized: description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Invalid: description: >- Unsupported parameter, invalid value, or a validation failure, with field-keyed details. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' 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.