> ## 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. # List all conversations by template > Fetch several conversation lists in one request, one per template named in `templates`. Callable by a signed-in company admin or rep whose role includes the messaging view permission. Pass `announcement_channel` or `my_downline` to include that single conversation. Every other template returns a page of your open (or, for `archived_*` templates, archived) conversations: `new_messages`, `pinned`, `team_groups`, `downline`, `team_directs`, `teams`, `teams_unread`, `teams_read`, `channels`, `channels_unread`, `channels_read`, `sms`, `sms_read`, `sms_unread`, `email`, `email_read`, `email_unread`, `customers`, `customers_unread`, `customers_read`, `archived_sms`, `archived_email`, `archived_directs`, `archived_groups`, `archived_teams`, `archived_channels`, `archived_customers`, and `bots`. Each list holds up to `per_page` conversations (default 5), except `new_messages`, which returns every match on one page. Unknown template names are ignored; with no `templates`, the response is an empty object. ## OpenAPI ````yaml /api-reference/messaging-v1.yaml get /api/v1/messaging/conversations/all openapi: 3.1.0 info: title: Fluid Messaging v1 API version: v1 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: messaging---conversations description: >- Create, list, update, and manage messaging conversations (direct, group, channel, SMS, email, and bot) as the signed-in company admin or rep. x-fluid-section: Messaging paths: /api/v1/messaging/conversations/all: get: tags: - messaging---conversations summary: List all conversations by template description: >- Fetch several conversation lists in one request, one per template named in `templates`. Callable by a signed-in company admin or rep whose role includes the messaging view permission. Pass `announcement_channel` or `my_downline` to include that single conversation. Every other template returns a page of your open (or, for `archived_*` templates, archived) conversations: `new_messages`, `pinned`, `team_groups`, `downline`, `team_directs`, `teams`, `teams_unread`, `teams_read`, `channels`, `channels_unread`, `channels_read`, `sms`, `sms_read`, `sms_unread`, `email`, `email_read`, `email_unread`, `customers`, `customers_unread`, `customers_read`, `archived_sms`, `archived_email`, `archived_directs`, `archived_groups`, `archived_teams`, `archived_channels`, `archived_customers`, and `bots`. Each list holds up to `per_page` conversations (default 5), except `new_messages`, which returns every match on one page. Unknown template names are ignored; with no `templates`, the response is an empty object. operationId: messaging_v1_list_all_conversations parameters: - name: templates in: query schema: type: string required: false description: Comma-separated list of template names - name: per_page in: query schema: type: integer required: false description: >- The number of conversations in each paginated template list. Defaults to 5. responses: '200': description: Conversations keyed by template name. content: application/json: schema: $ref: '#/components/schemas/MessagingConversationsByTemplate' example: announcement_channel: id: 90001 type: ChannelConversation kind: channel name: Announcements description: null status: open conversation_type: internal broadcasting: true auto_add_recipients: false announcing: true avatar_background_color: null avatar_emoji: null avatar_url: null image_url: null created_at: '2026-09-01T13:00:00Z' pinned_messages_count: 2 total_recipients: 58 unread: false pinned: true muted: false unread_messages_count: 0 scheduled_messages_count: 0 email_enabled?: false sms_enabled?: false messaging_enabled?: true draft_message: null recipients: - id: 48102 receivable_id: 7731 receivable_type: UserCompany first_name: Michael last_name: Scott status: active last_online: '2026-09-30T15:40:12Z' avatar_background: '#4F46E5' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 48211 receivable_id: 7802 receivable_type: UserCompany first_name: Dwight last_name: Schrute status: active last_online: '2026-09-30T14:58:03Z' avatar_background: '#0EA5E9' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 48307 receivable_id: 7859 receivable_type: UserCompany first_name: Jim last_name: Halpert status: active last_online: '2026-09-30T09:17:31Z' avatar_background: '#F59E0B' avatar_url: null image_url: null country_name: United States pro_user: false blocked: false left_conversation_at: null discarded_at: null - id: 48355 receivable_id: 7864 receivable_type: UserCompany first_name: Pam last_name: Beesly status: active last_online: '2026-09-29T21:03:55Z' avatar_background: '#EC4899' avatar_url: null image_url: null country_name: United States pro_user: false blocked: false left_conversation_at: null discarded_at: null - id: 48362 receivable_id: 7871 receivable_type: UserCompany first_name: Stanley last_name: Hudson status: active last_online: '2026-09-28T17:00:00Z' avatar_background: '#10B981' avatar_url: null image_url: null country_name: United States pro_user: false blocked: false left_conversation_at: null discarded_at: null creator: null pinned: - pagination: current: 1 previous: null next: null per_page: 5 pages: 1 count: 1 - items: - id: 90412 type: GroupConversation kind: group name: Scranton Sales Team description: >- Daily numbers and client follow-ups for the Scranton branch status: open conversation_type: internal broadcasting: null auto_add_recipients: null announcing: false avatar_background_color: null avatar_emoji: null avatar_url: null image_url: null created_at: '2026-09-14T15:42:07Z' pinned_messages_count: 1 total_recipients: 4 unread: true pinned: false muted: false unread_messages_count: 3 scheduled_messages_count: 0 email_enabled?: false sms_enabled?: false messaging_enabled?: true draft_message: null recipients: - id: 48102 receivable_id: 7731 receivable_type: UserCompany first_name: Michael last_name: Scott status: active last_online: '2026-09-30T15:40:12Z' avatar_background: '#4F46E5' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 48211 receivable_id: 7802 receivable_type: UserCompany first_name: Dwight last_name: Schrute status: active last_online: '2026-09-30T14:58:03Z' avatar_background: '#0EA5E9' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 48307 receivable_id: 7859 receivable_type: UserCompany first_name: Jim last_name: Halpert status: active last_online: '2026-09-30T09:17:31Z' avatar_background: '#F59E0B' avatar_url: null image_url: null country_name: United States pro_user: false blocked: false left_conversation_at: null discarded_at: null - id: 48362 receivable_id: 7871 receivable_type: UserCompany first_name: Stanley last_name: Hudson status: active last_online: '2026-09-28T17:00:00Z' avatar_background: '#10B981' avatar_url: null image_url: null country_name: United States pro_user: false blocked: false left_conversation_at: null discarded_at: null creator: id: 48102 first_name: Michael last_name: Scott avatar_background: '#4F46E5' image_url: null pro_user: true blocked: false blocker: false discarded_at: null customers_unread: - pagination: current: 1 previous: null next: null per_page: 5 pages: 1 count: 1 - items: - id: 90415 type: SmsConversation kind: null name: Holly Flax description: null status: open conversation_type: external broadcasting: null auto_add_recipients: null announcing: false avatar_background_color: null avatar_emoji: null avatar_url: null image_url: null created_at: '2026-09-22T18:05:44Z' pinned_messages_count: 0 total_recipients: 2 unread: false pinned: false muted: false unread_messages_count: 0 scheduled_messages_count: 0 email_enabled?: false sms_enabled?: true messaging_enabled?: true draft_message: null recipients: - id: 48102 receivable_id: 7731 receivable_type: UserCompany first_name: Michael last_name: Scott status: active last_online: '2026-09-30T15:40:12Z' avatar_background: '#4F46E5' avatar_url: null image_url: null country_name: United States pro_user: true blocked: false left_conversation_at: null discarded_at: null - id: 51944 receivable_id: 20318 receivable_type: Contact first_name: Holly last_name: Flax email: holly.flax@gmail.com phone: '+15705550142' avatar_background: '#8B5CF6' avatar_url: null image_url: null country_name: null pro_user: false blocked: false left_conversation_at: null discarded_at: null creator: id: 48102 first_name: Michael last_name: Scott avatar_background: '#4F46E5' image_url: null pro_user: true blocked: false blocker: false discarded_at: null '401': description: unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearer_auth: [] components: schemas: MessagingConversationsByTemplate: description: >- Conversations keyed by the requested template name. `announcement_channel` and `my_downline` hold a single conversation; every other template holds a page of conversations. Templates you did not request, or that are not recognised, are absent. type: object properties: announcement_channel: description: The company's announcement channel. anyOf: - $ref: '#/components/schemas/MessagingConversationSummary' - type: 'null' my_downline: description: Your downline conversation, or null if you do not have one yet. anyOf: - $ref: '#/components/schemas/MessagingConversationSummary' - type: 'null' additionalProperties: $ref: '#/components/schemas/MessagingConversationListPage' UnauthorizedResponse: type: object properties: message: type: string required: - message MessagingConversationSummary: description: >- A conversation as seen by the acting recipient. Per-recipient fields such as `unread`, `pinned`, and `muted` describe that recipient's view of the conversation. `recipients` lists at most six active participants; `total_recipients` is the full count. type: object properties: id: type: - integer - 'null' type: type: string description: The conversation type, for example `GroupConversation`. kind: type: - string - 'null' description: >- The short conversation kind (`direct`, `group`, `channel`, or `downline`), or null for SMS, email, and bot conversations. name: type: - string - 'null' description: type: - string - 'null' status: type: - string - 'null' description: >- One of `initiated`, `open`, `archived`, or `closed`. A new conversation stays `initiated` until its first message. conversation_type: type: - string - 'null' description: >- `internal` for conversations between company members, `external` for conversations with contacts. broadcasting: type: - boolean - 'null' auto_add_recipients: type: - boolean - 'null' announcing: type: - boolean - 'null' avatar_background_color: type: - string - 'null' avatar_emoji: type: - string - 'null' avatar_url: type: - string - 'null' image_url: type: - string - 'null' created_at: type: - string - 'null' format: date-time pinned_messages_count: type: - integer - 'null' total_recipients: type: - integer - 'null' unread: type: - boolean - 'null' pinned: type: - boolean - 'null' muted: type: - boolean - 'null' unread_messages_count: type: - integer - 'null' scheduled_messages_count: type: - integer - 'null' email_enabled?: type: - boolean - 'null' sms_enabled?: type: - boolean - 'null' messaging_enabled?: type: - boolean - 'null' description: Whether the acting recipient can post in the conversation. draft_message: description: The acting recipient's unsent draft in this conversation, or null. type: - object - 'null' recipients: type: array items: $ref: '#/components/schemas/MessagingConversationParticipant' creator: anyOf: - $ref: '#/components/schemas/MessagingConversationCreator' - type: 'null' required: - id - type - kind - name - description - status - conversation_type - broadcasting - auto_add_recipients - announcing - avatar_background_color - avatar_emoji - avatar_url - image_url - created_at - pinned_messages_count - total_recipients - unread - pinned - muted - unread_messages_count - scheduled_messages_count - email_enabled? - sms_enabled? - messaging_enabled? - draft_message - recipients - creator additionalProperties: false MessagingConversationListPage: description: >- A page of conversations, returned as a two-element array: an object holding `pagination`, then an object holding the conversations in `items`. type: array items: anyOf: - type: object properties: pagination: $ref: '#/components/schemas/MessagingConversationPagination' required: - pagination - type: object properties: items: type: array items: $ref: '#/components/schemas/MessagingConversationSummary' required: - items MessagingConversationParticipant: description: >- A participant in a conversation, as listed in the conversation's `recipients`. Company members carry `status` and `last_online`; contacts carry `email` and `phone` instead. type: object properties: id: type: integer description: >- The recipient ID. Pass it as `uid` to add this recipient to another conversation. receivable_id: type: - integer - 'null' receivable_type: type: - string - 'null' description: What the participant is, such as a company member or a contact. first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: - string - 'null' phone: type: - string - 'null' status: type: - string - 'null' last_online: type: - string - 'null' avatar_background: type: - string - 'null' avatar_url: type: - string - 'null' image_url: type: - string - 'null' country_name: type: - string - 'null' pro_user: type: - boolean - 'null' blocked: type: - boolean - 'null' description: Whether the acting recipient has blocked this participant. left_conversation_at: type: - string - 'null' conversation_messaging_enabled?: type: - boolean - 'null' discarded_at: type: - string - 'null' required: - id additionalProperties: false MessagingConversationCreator: description: The recipient who created a conversation. type: object properties: id: type: integer first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: - string - 'null' phone: type: - string - 'null' avatar_background: type: - string - 'null' image_url: type: - string - 'null' pro_user: type: - boolean - 'null' blocked: type: - boolean - 'null' blocker: type: - boolean - 'null' discarded_at: type: - string - 'null' required: - id additionalProperties: false MessagingConversationPagination: description: Page-number pagination details for a page of results. type: object properties: current: type: integer description: The page returned. previous: type: - integer - 'null' description: The previous page number, or null on the first page. next: type: - integer - 'null' description: The next page number, or null on the last page. per_page: type: integer description: The page size used. pages: type: integer description: The total number of pages. count: type: integer description: The total number of matching records. securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````