> ## 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. # Show a share and its activity > Returns a share with its recent events. Private and revalidated on every read, so a response is never replayed after the member loses access to the share's target or recipient. ## OpenAPI ````yaml /api-reference/member-content-v2026-10.yaml get /api/member/v2026-10/shares/{id} 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/shares/{id}: parameters: - name: id in: path required: true description: Public id of a share the signed-in member created. schema: type: string format: uuid get: tags: - shares summary: Show a share and its activity description: >- Returns a share with its recent events. Private and revalidated on every read, so a response is never replayed after the member loses access to the share's target or recipient. operationId: member_shares_show responses: '200': description: The share. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/ShareDetailEnvelope' example: status: 200 data: id: 0199a3f2-7d4f-7a7e-8d43-6e5f4a3b2c93 target: kind: product id: 0199a3f2-5c1e-7d4b-9a10-3b2c1d4e5f61 title: Primex Wellness Kit image_url: https://ik.imagekit.io/fluid/primex/wellness-kit.jpg channel: sms recipient: contact_id: 0199a3f2-7e50-7b8f-9e54-7f6a5b4c3da4 name: Jordan Lee url: https://primex.fluid.app/s/a1b2c3 opens_count: 4 last_opened_at: '2026-09-30T09:12:44.000000Z' created_at: '2026-09-28T19:03:27.000000Z' events: - type: converted occurred_at: '2026-09-30T09:20:03.000000Z' - type: visited occurred_at: '2026-09-30T09:12:44.000000Z' - type: created occurred_at: '2026-09-28T19:03:27.000000Z' meta: request_uuid: 0199a3f2-7a10-7c3e-8f21-4d5e6f708192 timestamp: '2026-09-30T18:24:05Z' '304': $ref: '#/components/responses/NotModified' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' 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. 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 schemas: ShareDetailEnvelope: type: object description: One share with its activity. properties: status: type: integer description: HTTP response status. data: $ref: '#/components/schemas/ShareDetail' meta: $ref: '#/components/schemas/ResponseMeta' required: - status - data - meta ShareDetail: description: A tracked link with its recent activity. allOf: - $ref: '#/components/schemas/ShareFields' - type: object properties: events: type: array description: >- Activity newest first: when the link was created, and its 50 most recent storefront visits and orders. Creation is not confirmation of delivery; the client delivers the link. items: type: object description: One event. additionalProperties: false properties: type: type: string description: What happened. enum: - created - visited - converted occurred_at: type: string format: date-time description: When it happened. required: - type - occurred_at required: - events 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 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 ShareFields: description: The share fields shared by list and detail. type: object properties: id: type: string format: uuid description: Public share id. target: $ref: '#/components/schemas/ShareTarget' channel: 7f35c9fb-ba67-45a9-aa30-ba9ba5cf8ab6 recipient: 29ba9ddf-aae8-49e0-b8e1-c97d65d6e522 url: type: string format: uri description: The tracked link to hand out. opens_count: type: integer description: How many times the tracked link has been opened. last_opened_at: type: - string - 'null' format: date-time description: When the link last led to a recorded storefront visit. created_at: type: string format: date-time description: When it was created. required: - id - target - channel - recipient - url - opens_count - last_opened_at - created_at ShareTarget: type: - object - 'null' description: >- Current summary of the shared target, or null if it no longer exists or is no longer readable by this member. Owned private kept playlists remain readable in history, although creating a new playlist share requires shared visibility. additionalProperties: false properties: kind: type: string description: Target kind. enum: - media - playlist - product - enrollment_pack - page id: type: string format: uuid description: Public id of the target. title: type: - string - 'null' description: Target title. image_url: type: - string - 'null' description: Target image, when it stores one. required: - kind - id - title - image_url responses: NotModified: description: The member's representation matches If-None-Match. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' Unauthorized: description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: >- The membership cannot share content, or the credential is read-only and the request writes. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: >- Missing identifier, malformed identifier, or a resource outside the member's scope. 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.