> ## 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. # Returns all available themeables for theme template > Lists the company's records of the template's type (for example products or pages) that can be assigned to this template, with the template currently assigned to each. Records already using this template are listed first, then by title. Requires the `application_themes` view permission. Paginated with `page` and `per_page` (default 20); only shareable template types are supported (400 otherwise). ## OpenAPI ````yaml /api-reference/themes-v0.yaml get /api/application_theme_templates/{id}/available_themeables openapi: 3.1.0 info: title: Fluid Themes API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/application_theme_templates/{id}/available_themeables: get: tags: - applicationthemetemplates summary: Returns all available themeables for theme template description: >- Lists the company's records of the template's type (for example products or pages) that can be assigned to this template, with the template currently assigned to each. Records already using this template are listed first, then by title. Requires the `application_themes` view permission. Paginated with `page` and `per_page` (default 20); only shareable template types are supported (400 otherwise). operationId: getThemeTemplateAvailableThemeables parameters: - name: page in: query required: false schema: type: integer minimum: 1 description: Page number, starting at 1. - name: per_page in: query required: false schema: type: integer minimum: 1 default: 20 description: Records per page. - name: selected in: query required: false schema: type: boolean description: Only return records already assigned to this template. - name: search in: query required: false schema: type: string description: Match against title, and SKU where the type has one. example: copy paper - name: status in: query required: false schema: type: string description: Only return records with this status, for types that have one. example: active - name: id in: path required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/GetApiApplicationThemeTemplatesByIdAvailableThemeablesResponse200ApplicationJsonSchema example: available_themeables: - id: 30117 title: Dunder Mifflin 20lb Copy Paper sku: DM-20LB-CASE image: >- https://cdn.fluid.app/dunder-mifflin/products/20lb-copy-paper.jpg themeable_type: product application_theme_template_id: 48213 - id: 30121 title: Scranton Branch Mug sku: DM-MUG-SCR image: >- https://cdn.fluid.app/dunder-mifflin/products/scranton-branch-mug.jpg themeable_type: product application_theme_template_id: null meta: request_id: 4f1c2a9e-7b3d-4e8a-9c61-2d5f8a0b3e17 timestamp: '2026-09-22T15:04:12Z' pagination: current_page: 1 total_pages: 1 total_count: 2 per_page: 20 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '404': description: template not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: GetApiApplicationThemeTemplatesByIdAvailableThemeablesResponse200ApplicationJsonSchema: type: object properties: available_themeables: type: array description: List of themeables that use the specified template items: type: object properties: id: type: integer description: ID of the themeable title: type: - string - 'null' description: Title of the themeable sku: type: - string - 'null' description: SKU, for themeable types that have one (products). image: type: - string - 'null' description: Image URL for the themeable themeable_type: type: string description: Type of the themeable application_theme_template_id: type: - integer - 'null' description: ID of the template that the themeable is assigned to meta: type: object description: Metadata about the request and response properties: request_id: type: - string - 'null' description: Unique identifier for the request timestamp: type: - string - 'null' description: Time when the request was processed pagination: $ref: '#/components/schemas/PaginationMeta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' PaginationMeta: type: object properties: total_count: type: integer total_pages: type: integer current_page: type: integer per_page: type: integer StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````