> ## 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. > 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. > 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/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); 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. > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. # Mark activities as read ## OpenAPI ````yaml /api-reference/company-v0.yaml post /api/activities/read openapi: 3.1.0 info: title: Fluid Company API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/activities/read: post: tags: - activities summary: Mark activities as read operationId: commerce_v0_activities_read_post responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CompanyUserActivityResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearer_auth: [] components: schemas: CompanyUserActivityResponse: type: object properties: active: type: boolean active_pro_subscription: type: 'null' activity_notifications: type: integer affiliate_id: type: integer affiliate_shop_url: type: string agree_statement: type: string agreed_to_all_terms: type: boolean agreements: type: 'null' bio: type: string business_details_filled: type: boolean business_phone_number: type: 'null' business_phone_number_status: type: 'null' catchups_onboarded: type: boolean companies: type: array items: $ref: '#/components/schemas/CompanyActivityCompany' company: $ref: '#/components/schemas/CompanyActivityCompany' company_unread_activities_count: type: integer country: type: object properties: id: type: integer iso: type: string name: type: string required: - id - iso - name additionalProperties: false created_at: type: string format: date-time default_wallets: type: array items: $ref: '#/components/schemas/JsonValue' dnd: type: string email: type: string email_notifications: type: boolean email_signature: type: string facebook: type: 'null' favicon_url: type: 'null' first_message_sent_at: type: 'null' first_name: type: string first_sign_in_at: type: 'null' fluid_shop: type: 'null' free_samples: type: boolean full_name: type: string icon_url: type: string id: type: integer image_url: type: 'null' instagram: type: 'null' jwt: type: 'null' language: type: object properties: active: type: boolean created_at: type: string format: date-time default: type: boolean id: type: integer iso: type: string name: type: string updated_at: type: string format: date-time uuid_v7: type: string required: - active - created_at - default - id - iso - name - updated_at - uuid_v7 additionalProperties: false last_name: type: string lead_capture: type: boolean leads_purchased_amount: type: 'null' leads_recurring: type: 'null' leads_remaining: type: 'null' leads_requested_per_day: type: 'null' linkedin: type: 'null' media_categories: type: array items: $ref: '#/components/schemas/JsonValue' media_tags: type: array items: $ref: '#/components/schemas/JsonValue' mysite_leads: type: integer mysite_theme: type: 'null' mysite_url: type: string mysite_views: type: integer open_task_count: type: integer phone: type: string pinterest: type: 'null' plan: type: 'null' premium_messaging_plan: type: object properties: amount: type: string company_id: type: integer default: type: boolean discount: type: string id: type: integer label: type: string net_amount: type: string renew_duration: type: string slug: type: string status: type: string required: - amount - company_id - default - discount - id - label - net_amount - renew_duration - slug - status additionalProperties: false pro_plans: type: array items: $ref: '#/components/schemas/JsonValue' profile_notifications: type: integer public_id: type: string push_notifications: type: boolean rank: type: 'null' replicated_url: type: - string - 'null' role: type: string share_link: type: string sms_notifications: type: boolean sms_registration_status: type: 'null' tiktok: type: 'null' time_zone: type: string token: type: string total_points: type: integer twitter: type: 'null' unread_messages_count: type: integer wechat: type: 'null' whatsapp: type: 'null' youtube: type: 'null' required: - active - active_pro_subscription - activity_notifications - affiliate_id - affiliate_shop_url - agree_statement - agreed_to_all_terms - agreements - bio - business_details_filled - business_phone_number - business_phone_number_status - catchups_onboarded - companies - company - company_unread_activities_count - country - created_at - default_wallets - dnd - email - email_notifications - email_signature - facebook - favicon_url - first_message_sent_at - first_name - first_sign_in_at - fluid_shop - free_samples - full_name - icon_url - id - image_url - instagram - jwt - language - last_name - lead_capture - leads_purchased_amount - leads_recurring - leads_remaining - leads_requested_per_day - linkedin - media_categories - media_tags - mysite_leads - mysite_theme - mysite_url - mysite_views - open_task_count - phone - pinterest - plan - premium_messaging_plan - pro_plans - profile_notifications - public_id - push_notifications - rank - replicated_url - role - share_link - sms_notifications - sms_registration_status - tiktok - time_zone - token - total_points - twitter - unread_messages_count - wechat - whatsapp - youtube additionalProperties: false UnauthorizedResponse: type: object properties: message: type: string required: - message CompanyActivityCompany: type: object properties: active: type: boolean agree_to_terms: type: 'null' appstore_url: type: string auto_add_new_products: type: boolean base_url: type: string color: type: string countries: type: array items: $ref: '#/components/schemas/CompanyActivityCountry' cv_to_usd_ratio: type: string default_country: $ref: '#/components/schemas/CompanyActivityDefaultCountry' disable_fluid_sign_in: type: boolean display_activities: type: boolean display_analytics: type: boolean display_announcements: type: boolean display_billing_zip: type: 'null' display_callpro: type: boolean display_catchups: type: boolean display_channel_messaging: type: boolean display_comments: type: boolean display_contact_activity: type: boolean display_contact_csv_export: type: boolean display_contact_csv_import: type: boolean display_contact_groups: type: boolean display_contacts: type: boolean display_courses: type: boolean display_direct_messaging: type: boolean display_discounts: type: boolean display_enrollments: type: boolean display_events: type: boolean display_explore: type: boolean display_get_started: type: boolean display_group_messaging: type: boolean display_leaderboard: type: boolean display_leads: type: boolean display_marketplace: type: boolean display_media: type: boolean display_member_shopping: type: boolean display_messaging: type: boolean display_mysite: type: boolean display_new_and_trending: type: boolean display_orders: type: boolean display_pages: type: boolean display_playlists: type: boolean display_points: type: boolean display_products: type: boolean display_promos: type: boolean display_recent_activity: type: boolean display_share: type: boolean display_share_stats: type: boolean display_shop: type: boolean display_tasks: type: boolean display_uploads: type: boolean display_wallet: type: boolean display_webchat: type: boolean enable_premium_messaging: type: boolean enable_reps_messaging: type: boolean feature_flags: type: object additionalProperties: false fluid_commission: type: string hide_reviews_rating: type: boolean icon_url: type: string id: type: integer impersonating: type: boolean invite_customers_to_download: type: 'null' languages: type: array items: $ref: '#/components/schemas/CompanyActivityLanguage' logo_url: type: string member_types: type: array items: $ref: '#/components/schemas/CompanyActivityMemberType' name: type: string playstore_url: type: string privacy_url: type: string promo_video_url: type: 'null' public: type: boolean reviews_on_orders: type: boolean sandbox: type: boolean settings: type: object properties: shipping: type: string required: - shipping additionalProperties: false shop_onboarded_at: type: 'null' show_commission_as_cv: type: boolean subdomain: type: string support_email: type: 'null' terms_url: type: string required: - active - agree_to_terms - appstore_url - auto_add_new_products - base_url - color - countries - cv_to_usd_ratio - default_country - disable_fluid_sign_in - display_activities - display_analytics - display_announcements - display_billing_zip - display_callpro - display_catchups - display_channel_messaging - display_comments - display_contact_activity - display_contact_csv_export - display_contact_csv_import - display_contact_groups - display_contacts - display_courses - display_direct_messaging - display_discounts - display_enrollments - display_events - display_explore - display_get_started - display_group_messaging - display_leaderboard - display_leads - display_marketplace - display_media - display_member_shopping - display_messaging - display_mysite - display_new_and_trending - display_orders - display_pages - display_playlists - display_points - display_products - display_promos - display_recent_activity - display_share - display_share_stats - display_shop - display_tasks - display_uploads - display_wallet - display_webchat - enable_premium_messaging - enable_reps_messaging - feature_flags - fluid_commission - hide_reviews_rating - icon_url - id - impersonating - invite_customers_to_download - languages - logo_url - member_types - name - playstore_url - privacy_url - promo_video_url - public - reviews_on_orders - sandbox - settings - shop_onboarded_at - show_commission_as_cv - subdomain - support_email - terms_url additionalProperties: false 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' CompanyActivityCountry: type: object properties: active: type: boolean address3: type: boolean currency_code: type: string currency_symbol: type: string delimiter: type: string id: type: integer iso: type: string iso3: type: string iso_name: type: string name: type: string numcode: type: integer separator: type: string tax_rates: type: 'null' required: - active - address3 - currency_code - currency_symbol - delimiter - id - iso - iso3 - iso_name - name - numcode - separator - tax_rates additionalProperties: false CompanyActivityDefaultCountry: type: object properties: active: type: boolean address3: type: boolean address_requires_province: type: 'null' certified: type: boolean checkout_requires_terms: type: 'null' configuration: type: object additionalProperties: false created_at: type: string format: date-time currency_code: type: string currency_symbol: type: string default: type: boolean delimiter: type: string eu: type: 'null' geo_entity_id: type: 'null' id: type: integer iso: type: string iso3: type: string iso_name: type: string name: type: string numcode: type: integer separator: type: string settings: type: - object - 'null' tax_enabled: type: 'null' tax_inclusive: type: 'null' tax_invoice_required: type: 'null' tax_local_abbreviation: type: 'null' tax_local_name: type: 'null' tax_name: type: 'null' tax_provinces: type: 'null' tax_rates: type: 'null' tax_standard_rate: type: 'null' updated_at: type: string format: date-time uuid_v7: type: string required: - active - address3 - address_requires_province - certified - checkout_requires_terms - configuration - created_at - currency_code - currency_symbol - default - delimiter - eu - geo_entity_id - id - iso - iso3 - iso_name - name - numcode - separator - settings - tax_enabled - tax_inclusive - tax_invoice_required - tax_local_abbreviation - tax_local_name - tax_name - tax_provinces - tax_rates - tax_standard_rate - updated_at - uuid_v7 additionalProperties: false CompanyActivityLanguage: type: object properties: active: type: boolean id: type: integer iso: type: string name: type: string required: - active - id - iso - name additionalProperties: false CompanyActivityMemberType: type: object properties: id: type: string name: type: string slug: type: string system_defined: type: boolean required: - id - name - slug - system_defined additionalProperties: false securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````